public interface SupersedingEventSearch extends OsidSearch
SupersedingEventSearch
defines the interface for
specifying superseding event search options.
Modifier and Type | Method and Description |
---|---|
SupersedingEventSearchRecord |
getSupersedingEventSearchRecord(Type supersedingEventSearchRecordType)
Gets the superseding event search record corresponding to the given
superseding event search record
Type. |
void |
orderSupersedingEventResults(SupersedingEventSearchOrder supersedingEventSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSupersedingEvents(IdList supersedingEventIds)
Execute this search among the given list of superseding events.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSupersedingEvents(IdList supersedingEventIds)
supersedingEventIds
- list of superseding eventsNullArgumentException
- supersedingEventIds
is null
mandatory
- This method must be implemented. void orderSupersedingEventResults(SupersedingEventSearchOrder supersedingEventSearchOrder)
supersedingEventSearchOrder
- superseding event search orderNullArgumentException
-
supersedingEventSearchOrder
is null
UnsupportedException
-
superedingEventSearchOrder
is not of this servicemandatory
- This method must be implemented. SupersedingEventSearchRecord getSupersedingEventSearchRecord(Type supersedingEventSearchRecordType) throws OperationFailedException
Type.
supersedingEventSearchRecordType
- a superseding event search
record typeNullArgumentException
-
supersedingEventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(supersedingEventSearchRecordType)
is
false
mandatory
- This method must be implemented.