public interface EventSearch extends OsidSearch
EventSearch
defines the interface for specifying event
search options.
Modifier and Type | Method and Description |
---|---|
EventSearchRecord |
getEventSearchRecord(Type eventSearchRecordType)
Gets the event search record corresponding to the given event search
record
Type. |
void |
orderEventResults(EventSearchOrder eventSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongEvents(IdList eventIds)
Execute this search among the given list of events.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongEvents(IdList eventIds)
eventIds
- list of eventsNullArgumentException
- eventIds
is
null
mandatory
- This method must be implemented. void orderEventResults(EventSearchOrder eventSearchOrder)
eventSearchOrder
- event search orderNullArgumentException
- eventSearchOrder
is null
UnsupportedException
- eventSearchOrder
is not of this servicemandatory
- This method must be implemented. EventSearchRecord getEventSearchRecord(Type eventSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.eventSearchRecordType
- an event search record typeNullArgumentException
- eventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(eventSearchRecordType)
is false
mandatory
- This method must be implemented.