public interface AgencySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
AgencyList |
getAgencies()
Gets the agency list resultrng from a search.
|
AgencyQueryInspector |
getAgencyQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AgencySearchResultsRecord |
getAgencySearchResultsRecord(Type agencySearchRecordType)
Gets the record corresponding to the given agency search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AgencyList getAgencies()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. AgencyQueryInspector getAgencyQueryInspector()
mandatory
- This method must be implemented. AgencySearchResultsRecord getAgencySearchResultsRecord(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.