Search Mode (Core Services)
The search mode is an enumeration of the possible values for specifying the search criteria. The search mode specifies which values are returned relative to the search's start and end times. The following values are accepted:
-
None
This is the value of an uninitialized search mode.
-
StartInclusive
Includes all objects whose start time is within the specified range. Also known as "Starting Between".
-
EndInclusive
Includes all objects whose end time is within the specified range. Also known as "Ending Between".
-
Inclusive
Includes all objects whose start and end time are within the specified range. Also known as "Entirely Between".
-
Overlapped
Includes all objects whose start or end time overlap with the specified range. Also known as "Active Between".
-
InProgress
Includes all objects whose start time is within the specified range and end time is December 31, 9999. Also known as "Starting Between and In Progress".
The following search modes apply only to event frame searches:
-
BackwardFromStartTime
Event frames with a start time less than or equal to the time specified in the search (moving backward in time) are returned from the search. Also known as "Starting Before".
-
ForwardFromStartTime
Event frames with a start time greater than or equal to the time specified in the search (moving forward in time) are returned from the search. Also known as "Starting After".
-
BackwardFromEndTime
Event frames with an end time less than or equal to the time specified in the search (moving backward in time) are returned from the search. Also known as "Ending Before".
-
ForwardFromEndTime
Event frames with an end time greater than or equal to the time specified in the search (moving forward in time) are returned from the search. Also know as "Ending After".
-
BackwardInProgress
Event frames with a start time less than or equal to the time specified in the search (moving backward in time) that are still in progress (an end time set to December 31, 9999) are returned from the search. Also known as "Starting Before and In Progress".
-
ForwardInProgress
Event frames with a start time greater than or equal to the time specified in the search (moving forward in time) that are still in progress (an end time set to December 31, 9999) are returned from the search. Also known as "Starting After and In Progress".
Important
Note that object values which end on the search start time or start on the search end time are not included as part of the returned collection.
