public interface HoldEnablerSearch extends OsidSearch
The search interface for governing hold enabler searches.
Modifier and Type | Method and Description |
---|---|
HoldEnablerSearchRecord |
getHoldEnablerSearchRecord(Type holdEnablerSearchRecordType)
Gets the hold enabler search record corresponding to the given hold
enabler search record
Type. |
void |
orderHoldEnablerResults(HoldEnablerSearchOrder holdEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongHoldEnablers(IdList holdEnablerIds)
Execute this search among the given list of hold enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongHoldEnablers(IdList holdEnablerIds)
holdEnablerIds
- list of hold enablersNullArgumentException
- holdEnablerIds
is null
mandatory
- This method must be implemented. void orderHoldEnablerResults(HoldEnablerSearchOrder holdEnablerSearchOrder)
holdEnablerSearchOrder
- hold enabler search orderNullArgumentException
- holdEnablerSearchOrder
is null
UnsupportedException
- holdEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. HoldEnablerSearchRecord getHoldEnablerSearchRecord(Type holdEnablerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.holdEnablerSearchRecordType
- a hold enabler search record typeNullArgumentException
-
holdEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(holdEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.