UpdateSpecific Method (ShiftPattern)

• Visual Basic
• C#

'Declaration
 
Public Shared Sub UpdateSpecific( _
   ByVal sessionId As Integer, _
   ByVal patternId As Integer, _
   ByVal patternName As String, _
   ByVal startEffLocal As Nullable(Of Date), _
   ByVal endEffLocal As DBDateTime, _
   ByVal recurring As Nullable(Of Boolean), _
   ByVal additive As Nullable(Of Boolean), _
   ByVal enabled As Nullable(Of Boolean), _
   ByVal comments As DBString, _
   ByRef lastEditAt As Nullable(Of Date) _
) 

'Usage
 
Dim sessionId As Integer
Dim patternId As Integer
Dim patternName As String
Dim startEffLocal As Nullable(Of Date)
Dim endEffLocal As DBDateTime
Dim recurring As Nullable(Of Boolean)
Dim additive As Nullable(Of Boolean)
Dim enabled As Nullable(Of Boolean)
Dim comments As DBString
Dim lastEditAt As Nullable(Of Date)
 
ShiftPattern.UpdateSpecific(sessionId, patternId, patternName, startEffLocal, endEffLocal, recurring, additive, enabled, comments, lastEditAt)

public static void UpdateSpecific( 
   int sessionId,
   int patternId,
   string patternName,
   Nullable<DateTime> startEffLocal,
   DBDateTime endEffLocal,
   Nullable<bool> recurring,
   Nullable<bool> additive,
   Nullable<bool> enabled,
   DBString comments,
   ref Nullable<DateTime> lastEditAt
)

Parameters

sessionId

Required. Holds the session ID and thus the user who is making this method call.

patternId

Required. Holds the shift pattern ID.

patternName

Optional. Holds the shift pattern name.

startEffLocal

Optional. Holds effective local start time of the shift pattern.

endEffLocal

Optional. Holds effective local end time of the shift pattern.

recurring

Optional. Holds a flag that, if set to true, specifies that the pattern's shift schedule is recurring (a regular or overtime shift) within its effective time period. If set to false, specifies that the pattern is a holiday exception and that it cannot have a shift schedule.

additive

Optional. Holds a flag that, if set to true, specifies that the shift is additive (Overtime). If set to false, specifies that the shift is a regular shift. Only used when recurring is true.

enabled

Optional. Holds a flag that, if set to true, specifies that the shift pattern is enabled.

comments

Optional. Holds comments about the shift pattern.

lastEditAt

Optional. Holds the datetime when this record was added or last edited, for optimistic concurrency control. If it is specified, the passed value must match the lastEditAt value in the record for the update to succeed.

Output. Holds the datetime value when this record was updated by this called method.