Interface AvailabilitySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AvailabilitySearch
extends OsidSearch

The search interface for governing availability searches.

Method Summary

Modifier and Type	Method	Description
AvailabilitySearchRecord	getAvailabilitySearchRecord(Type availabilitySearchRecordType)	Gets the availability search record corresponding to the given availability search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAvailabilityResults(AvailabilitySearchOrder availabilitySearchOrder)	Specify an ordering to the search results.
void	searchAmongAvailabilities(IdList availabilityIds)	Execute this search among the given list of availabilities.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAvailabilities

void searchAmongAvailabilities(IdList availabilityIds)

Execute this search among the given list of availabilities.

Parameters:

availabilityIds - list of availabilities

Throws:

NullArgumentException - availabilityIds is null

Compliance:

mandatory - This method must be implemented.

orderAvailabilityResults

void orderAvailabilityResults(AvailabilitySearchOrder availabilitySearchOrder)

Specify an ordering to the search results.

Parameters:

availabilitySearchOrder - availability search order

Throws:

NullArgumentException - availabilitySearchOrder is null

UnsupportedException - availabilitySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAvailabilitySearchRecord

AvailabilitySearchRecord getAvailabilitySearchRecord(Type availabilitySearchRecordType)
                                              throws OperationFailedException

Gets the availability search 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 record

Throws:

NullArgumentException - availabilitySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilitySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.