public interface OffsetEventSearch extends OsidSearch
OffsetEventSearch
defines the interface for specifying
offset event search options.
Modifier and Type | Method and Description |
---|---|
OffsetEventSearchRecord |
getOffsetEventSearchRecord(Type offsetEventSearchRecordType)
Gets the offset event search record corresponding to the given offset
event search record
Type. |
void |
orderOffsetEventResults(OffsetEventSearchOrder offsetEventSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongOffsetEvents(IdList offsetEventIds)
Execute this search among the given list of offset events.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongOffsetEvents(IdList offsetEventIds)
offsetEventIds
- list of offset eventsNullArgumentException
- offsetEventIds
is null
mandatory
- This method must be implemented. void orderOffsetEventResults(OffsetEventSearchOrder offsetEventSearchOrder)
offsetEventSearchOrder
- offset event search orderNullArgumentException
- offsetEventSearchOrder
is null
UnsupportedException
- offsetEventSearchOrder
is not of this servicemandatory
- This method must be implemented. OffsetEventSearchRecord getOffsetEventSearchRecord(Type offsetEventSearchRecordType) throws OperationFailedException
Type.
offsetEventSearchRecordType
- an offset event search record typeNullArgumentException
-
offsetEventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offsetEventSearchRecordType)
is
false
mandatory
- This method must be implemented.