public interface RecurringEventSearch extends OsidSearch
RecurringEventSearch
defines the interface for
specifying recurring event search options.
Modifier and Type | Method and Description |
---|---|
RecurringEventSearchRecord |
getRecurringEventSearchRecord(Type recurringEventSearchRecordType)
Gets the recurring event record corresponding to the given recurring
event search record
Type. |
void |
orderRecurringEventResults(RecurringEventSearchOrder recurringEventSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRecurringEvents(IdList recurringEventIds)
Execute this search among the given list of recurring events.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRecurringEvents(IdList recurringEventIds)
recurringEventIds
- list of recurring eventsNullArgumentException
- recurringEventIds
is null
mandatory
- This method must be implemented. void orderRecurringEventResults(RecurringEventSearchOrder recurringEventSearchOrder)
recurringEventSearchOrder
- recurring event search orderNullArgumentException
-
recurringEventSearchOrder
is null
UnsupportedException
- recurringEventSearchOrder
is not of this servicemandatory
- This method must be implemented. RecurringEventSearchRecord getRecurringEventSearchRecord(Type recurringEventSearchRecordType) throws OperationFailedException
Type.
recurringEventSearchRecordType
- a recurring event search record
typeNullArgumentException
-
recurringEventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(recurringEventSearchRecordType)
is
false
mandatory
- This method must be implemented.