public interface ControllerSearch extends OsidSearch
The search interface for governing controller searches.
Modifier and Type | Method and Description |
---|---|
ControllerSearchRecord |
getControllerSearchRecord(Type controllerSearchRecordType)
Gets the controller search record corresponding to the given
controller search record
Type. |
void |
orderControllerResults(ControllerSearchOrder controllerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongControllers(IdList controllerIds)
Execute this search among the given list of controllers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongControllers(IdList controllerIds)
controllerIds
- list of controllersNullArgumentException
- controllerIds
is
null
mandatory
- This method must be implemented. void orderControllerResults(ControllerSearchOrder controllerSearchOrder)
controllerSearchOrder
- controller search orderNullArgumentException
- controllerSearchOrder
is null
UnsupportedException
- controllerSearchOrder
is not of this servicemandatory
- This method must be implemented. ControllerSearchRecord getControllerSearchRecord(Type controllerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.controllerSearchRecordType
- a controller search record typeNullArgumentException
-
controllerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(controllerSearchRecordType)
is
false
mandatory
- This method must be implemented.