public interface OfficeSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
OfficeQueryInspector |
getOfficeQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
OfficeList |
getOffices()
Gets the office list resulting from a search.
|
OfficeSearchResultsRecord |
getOfficeSearchResultsRecord(Type officeSearchRecordType)
Gets the office search results record corresponding to the given
office search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
OfficeList getOffices()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. OfficeQueryInspector getOfficeQueryInspector()
mandatory
- This method must be implemented. OfficeSearchResultsRecord getOfficeSearchResultsRecord(Type officeSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.officeSearchRecordType
- a office search record typeNullArgumentException
- officeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(officeSearchRecordType)
is false
mandatory
- This method must be implemented.