public interface CyclicEventSearch extends OsidSearch
EventSearch
defines the interface for specifying event
search options.
Modifier and Type | Method and Description |
---|---|
CyclicEventSearchRecord |
getCyclicEventSearchRecord(Type cyclicEventSearchRecordType)
Gets the cyclic event search record corresponding to the given event
search record
Type. |
void |
orderCyclicEventResults(CyclicEventSearchOrder cyclicEventSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCyclicEvents(IdList cyclicEventIds)
Execute this search among the given list of events.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCyclicEvents(IdList cyclicEventIds)
cyclicEventIds
- list of eventsNullArgumentException
- cyclicEventIds
is null
mandatory
- This method must be implemented. void orderCyclicEventResults(CyclicEventSearchOrder cyclicEventSearchOrder)
cyclicEventSearchOrder
- event search orderNullArgumentException
- cyclicEventSearchOrder
is null
UnsupportedException
- cyclicEventSearchOrder
is not of this servicemandatory
- This method must be implemented. CyclicEventSearchRecord getCyclicEventSearchRecord(Type cyclicEventSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.cyclicEventSearchRecordType
- a cyclic event search record typeNullArgumentException
-
cyclicEventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicEventSearchRecordType)
is
false
mandatory
- This method must be implemented.