GetByFilter(String,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Nullable<Int32>,Nullable<Int32>,Boolean) Method

• Visual Basic
• C#

'Declaration
 
Public Overloads Shared Function GetByFilter( _
   ByVal woId As String, _
   ByVal itemId As String, _
   ByVal newState As Boolean, _
   ByVal readyState As Boolean, _
   ByVal runningState As Boolean, _
   ByVal completeState As Boolean, _
   ByVal suspendedState As Boolean, _
   ByVal onHoldState As Boolean, _
   ByVal targetSchedLineId As Nullable(Of Integer), _
   ByVal numberOfWorkOrders As Nullable(Of Integer), _
   ByVal includeWorkOrdersFromProcess As Boolean _
) As DataSet

'Usage
 
Dim woId As String
Dim itemId As String
Dim newState As Boolean
Dim readyState As Boolean
Dim runningState As Boolean
Dim completeState As Boolean
Dim suspendedState As Boolean
Dim onHoldState As Boolean
Dim targetSchedLineId As Nullable(Of Integer)
Dim numberOfWorkOrders As Nullable(Of Integer)
Dim includeWorkOrdersFromProcess As Boolean
Dim value As DataSet
 
value = WO.GetByFilter(woId, itemId, newState, readyState, runningState, completeState, suspendedState, onHoldState, targetSchedLineId, numberOfWorkOrders, includeWorkOrdersFromProcess)

public static DataSet GetByFilter( 
   string woId,
   string itemId,
   bool newState,
   bool readyState,
   bool runningState,
   bool completeState,
   bool suspendedState,
   bool onHoldState,
   Nullable<int> targetSchedLineId,
   Nullable<int> numberOfWorkOrders,
   bool includeWorkOrdersFromProcess
)

Parameters

woId

Optional filter parameter. Holds the ID of the work order to be retrieved.

itemId

Optional filter parameter. Holds the ID of an item for the work order.

newState

Required filter parameter. Holds a flag that indicates whether the work order's state is new.

readyState

Required filter parameter. Holds a flag that indicates whether the work order's state is ready.

runningState

Required filter parameter. Holds a flag that indicates whether the work order's state is running.

completeState

Required filter parameter. Holds a flag that indicates whether the work order's state is complete.

suspendedState

Required filter parameter. Holds a flag that indicates whether the work order's state is suspended.

onHoldState

Required filter parameter. Holds a flag that indicates whether the work order's state is onhold.

targetSchedLineId

Optional filter parameter. Holds a value that specifies work orders based on their line assignment, according to the following rules:

• If 0 or greater, returns only the work orders that have been assigned to the line whose ID is specified by the provided value. Note that 0 is a valid line ID.
• If -1, does not filter on the line assignment field of the WO table.
• If null, returns all work orders that have not been assigned to a line.

numberOfWorkOrders

Optional parameter. Holds an integer value that indicates the maximum number of work order records to be returned. The most recently created work orders (that is, those with the greatest row_id column values) are returned.

includeWorkOrdersFromProcess

Required. Holds a flag that indicates whether work orders that were created from processes should be returned in the DataSet. If the flag is set to false, the DataSet will not contain work orders that were created from processes. If the flag is set to true, the DataSet will contain work orders created from processes.

Return Value