GetAll Method (ShiftSchedule)
- Last UpdatedNov 06, 2025
- 4 minute read
The GetAll() method retrieves one or more shift schedule records from the Shift_Schedule table, as specified by the filter parameters. Passing no filter parameters will retrieve all shift schedule records from the table.
'Declaration
Public Shared Function GetAll( _
ByVal patternId As Nullable(Of Integer), _
ByVal startTime As Nullable(Of Date), _
ByVal endTime As Nullable(Of Date), _
ByVal shiftId As Nullable(Of Integer), _
ByVal sunday As Nullable(Of Boolean), _
ByVal monday As Nullable(Of Boolean), _
ByVal tuesday As Nullable(Of Boolean), _
ByVal wednesday As Nullable(Of Boolean), _
ByVal thursday As Nullable(Of Boolean), _
ByVal friday As Nullable(Of Boolean), _
ByVal saturday As Nullable(Of Boolean), _
ByVal enabled As Nullable(Of Boolean), _
ByVal lastEditBy As String, _
ByVal lastEditAt As Nullable(Of Date) _
) As DataSet
'Usage
Dim patternId As Nullable(Of Integer)
Dim startTime As Nullable(Of Date)
Dim endTime As Nullable(Of Date)
Dim shiftId As Nullable(Of Integer)
Dim sunday As Nullable(Of Boolean)
Dim monday As Nullable(Of Boolean)
Dim tuesday As Nullable(Of Boolean)
Dim wednesday As Nullable(Of Boolean)
Dim thursday As Nullable(Of Boolean)
Dim friday As Nullable(Of Boolean)
Dim saturday As Nullable(Of Boolean)
Dim enabled As Nullable(Of Boolean)
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = ShiftSchedule.GetAll(patternId, startTime, endTime, shiftId, sunday, monday, tuesday, wednesday, thursday, friday, saturday, enabled, lastEditBy, lastEditAt)
public static DataSet GetAll(
Nullable<int> patternId,
Nullable<DateTime> startTime,
Nullable<DateTime> endTime,
Nullable<int> shiftId,
Nullable<bool> sunday,
Nullable<bool> monday,
Nullable<bool> tuesday,
Nullable<bool> wednesday,
Nullable<bool> thursday,
Nullable<bool> friday,
Nullable<bool> saturday,
Nullable<bool> enabled,
string lastEditBy,
Nullable<DateTime> lastEditAt
)
Parameters
- patternId
- Required. Holds the ID of the shift pattern.
- startTime
- Optional filter parameter. Holds a shift start time (the date portion of the parameter is ignored). When the shift pattern for this shift schedule is assigned to entities, this time is considered to be in the local time specific to each entity.
- endTime
- Optional filter parameter. Holds a shift end time (the date portion of the parameter is ignored). When the shift pattern for this shift schedule is assigned to entities, this time is considered to be in the local time specific to each entity.
- shiftId
- Optional filter parameter. Holds the ID of the shift to which the schedule applies.
- sunday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Sunday.
- monday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Monday.
- tuesday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Tuesday.
- wednesday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Wednesday.
- thursday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Thursday.
- friday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Friday.
- saturday
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled on Saturday.
- enabled
- Optional filter parameter. Holds a flag that indicates whether the shift is enabled.
- lastEditBy
- Optional filter parameter. Holds the name of the user who added or last changed a shift schedule record.
- lastEditAt
- Optional filter parameter. Holds the date/time when a shift schedule record was added or last changed.
Return Value
Returns a DataSet that contains records for all the shift schedules that satisfy the specified filters. If no matching shift schedules are found, an empty DataSet is returned.
The columns of the returned DataSet are described below.
| Column Name | Description |
|---|---|
| pattern_id | An integer that is the ID of the shift pattern to which the shift is assigned. |
| start_time | A date/time that is the shift start time. |
| end_time | A date/time that is the shift end time. |
| end_day_span | An integer that is the end day span. |
| shift_id | An integer that is the shift ID. |
| sunday | A Boolean flag that indicates whether the shift is enabled on Sunday. |
| monday | A Boolean flag that indicates whether the shift is enabled on Monday. |
| tuesday | A Boolean flag that indicates whether the shift is enabled on Tuesday. |
| wednesday | A Boolean flag that indicates whether the shift is enabled on Wednesday. |
| thursday | A Boolean flag that indicates whether the shift is enabled on Thursday. |
| friday | A Boolean flag that indicates whether the shift is enabled on Friday. |
| saturday | A Boolean flag that indicates whether the shift is enabled on Saturday. |
| break1_start | A date/time that is the break1 start time. |
| break1_end | A date/time that is the break1 end time. |
| break2_start | A date/time that is the break2 start time. |
| break2_end | A date/time that is the break2 end time. |
| break3_start | A date/time that is the break3 start time. |
| break3_end | A date/time that is the break3 end time. |
| last_edit_by | A string that is the ID of the user who added or last updated this record. |
| last_edit_at | A date/time that indicates when the record was added or last updated. |