public interface AgencySearch extends OsidSearch
The interface for governing agency searches.
Modifier and Type | Method and Description |
---|---|
AgencySearchRecord |
getAgencySearchRecord(Type agencySearchRecordType)
Gets the record corresponding to the given agency search record
Type. |
void |
orderAgencyResults(AgencySearchOrder agencySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAgencies(IdList agencyIds)
Execute this search among the given list of agencies.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAgencies(IdList agencyIds)
agencyIds
- list of agenciesNullArgumentException
- agencyIds
is
null
mandatory
- This method must be implemented. void orderAgencyResults(AgencySearchOrder agencySearchOrder)
agencySearchOrder
- agency search orderNullArgumentException
- agencySearchOrder
is null
UnsupportedException
- agencySearchOrder
is not of this servicemandatory
- This method must be implemented. AgencySearchRecord getAgencySearchRecord(Type agencySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.agencySearchRecordType
- an agency search record typeNullArgumentException
- agencySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(agencySearchRecordType)
is false
mandatory
- This method must be implemented.