public interface SystemSearch extends OsidSearch
The search interface for governing system searches.
Modifier and Type | Method and Description |
---|---|
SystemSearchRecord |
getSystemSearchRecord(Type systemSearchRecordType)
Gets the system search record corresponding to the given system search
record
Type. |
void |
orderSystemResults(SystemSearchOrder systemSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSystems(IdList systemIds)
Execute this search among the given list of systems.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSystems(IdList systemIds)
systemIds
- list of systemsNullArgumentException
- systemIds
is
null
mandatory
- This method must be implemented. void orderSystemResults(SystemSearchOrder systemSearchOrder)
systemSearchOrder
- system search orderNullArgumentException
- systemSearchOrder
is null
UnsupportedException
- systemSearchOrder
is not of this servicemandatory
- This method must be implemented. SystemSearchRecord getSystemSearchRecord(Type systemSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.systemSearchRecordType
- a system search record typeNullArgumentException
- systemSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(systemSearchRecordType)
is false
mandatory
- This method must be implemented.