public interface AvailabilitySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
AvailabilityList |
getAvailabilities()
Gets the availability list resulting from a search.
|
AvailabilityQueryInspector |
getAvailabilityQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AvailabilitySearchResultsRecord |
getAvailabilitySearchResultsRecord(Type availabilitySearchRecordType)
Gets the availability search results record corresponding to the given
availability search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AvailabilityList getAvailabilities()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. AvailabilityQueryInspector getAvailabilityQueryInspector()
mandatory
- This method must be implemented. AvailabilitySearchResultsRecord getAvailabilitySearchResultsRecord(Type availabilitySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.availabilitySearchRecordType
- an availability search record
typeNullArgumentException
-
availabilitySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(availabilitySearchRecordType)
is
false
mandatory
- This method must be implemented.