public interface RecurringEventEnablerSearch extends OsidSearch
The search interface for governing recurring event enabler searches.
Modifier and Type | Method and Description |
---|---|
RecurringEventEnablerSearchRecord |
getRecurringEventEnablerSearchRecord(Type recurringEventEnablerSearchRecordType)
Gets the recurring event enabler search record corresponding to the
given recurring event enabler search record
Type. |
void |
orderRecurringEventEnablerResults(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRecurringEventEnablers(IdList recurringEventEnablerIds)
Execute this search among the given list of recurring event enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRecurringEventEnablers(IdList recurringEventEnablerIds)
recurringEventEnablerIds
- list of recurring event enablersNullArgumentException
- recurringEventEnablerIds
is null
mandatory
- This method must be implemented. void orderRecurringEventEnablerResults(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)
recurringEventEnablerSearchOrder
- recurring event enabler
search orderNullArgumentException
-
recurringEventEnablerSearchOrder
is null
UnsupportedException
-
recurringEventEnablerSearchOrder
is not of this
servicemandatory
- This method must be implemented. RecurringEventEnablerSearchRecord getRecurringEventEnablerSearchRecord(Type recurringEventEnablerSearchRecordType) throws OperationFailedException
Type.
This
method is used to retrieve an object implementing the requested
record.recurringEventEnablerSearchRecordType
- a recurring event
enabler search record typeNullArgumentException
-
recurringEventEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(recurringEventEnablerSearchRecordType)
is false
mandatory
- This method must be implemented.