Interface AvailabilitySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AvailabilitySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getAvailabilities

AvailabilityList getAvailabilities()

Gets the availability list resulting from a search.

Returns:

the availability list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAvailabilityQueryInspector

AvailabilityQueryInspector getAvailabilityQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the availability query inspector

Compliance:

mandatory - This method must be implemented.

getAvailabilitySearchResultsRecord

AvailabilitySearchResultsRecord getAvailabilitySearchResultsRecord(Type availabilitySearchRecordType)
                                                            throws OperationFailedException

Gets the availability search results record corresponding to the given availability search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

availabilitySearchRecordType - an availability search record type

Returns:

the availability search results record

Throws:

NullArgumentException - availabilitySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilitySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.