public interface UtilitySearch extends OsidSearch
The search interface for governing utility searches.
Modifier and Type | Method and Description |
---|---|
UtilitySearchRecord |
getUtilitySearchRecord(Type utilitySearchRecordType)
Gets the utility search record corresponding to the given utility
search record
Type. |
void |
orderUtilityResults(UtilitySearchOrder utilitySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongUtilities(IdList utilityIds)
Execute this search among the given list of utilities.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongUtilities(IdList utilityIds)
utilityIds
- list of utilitiesNullArgumentException
- utilityIds
is
null
mandatory
- This method must be implemented. void orderUtilityResults(UtilitySearchOrder utilitySearchOrder)
utilitySearchOrder
- utility search orderNullArgumentException
- utilitySearchOrder
is null
UnsupportedException
- utilitySearchOrder
is not of this servicemandatory
- This method must be implemented. UtilitySearchRecord getUtilitySearchRecord(Type utilitySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.utilitySearchRecordType
- a utility search record typeNullArgumentException
- utilitySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(utilitySearchRecordType)
is false
mandatory
- This method must be implemented.