Interface AvailabilityEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AvailabilityEnablerSearch
extends OsidSearch

The search interface for governing availability enabler searches.

Method Summary

Modifier and Type	Method	Description
AvailabilityEnablerSearchRecord	getAvailabilityEnablerSearchRecord(Type availabilityEnablerSearchRecordType)	Gets the availability enabler search record corresponding to the given availability enabler search record Type.
void	orderAvailabilityEnablerResults(AvailabilityEnablerSearchOrder availabilityEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAvailabilityEnablers(IdList foundryIds)	Execute this search among the given list of availability enablers.

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

searchAmongAvailabilityEnablers

void searchAmongAvailabilityEnablers(IdList foundryIds)

Execute this search among the given list of availability enablers.

Parameters:

foundryIds - list of availability enablers

Throws:

NullArgumentException - foundryIds is null

Compliance:

mandatory - This method must be implemented.

orderAvailabilityEnablerResults

void orderAvailabilityEnablerResults(AvailabilityEnablerSearchOrder availabilityEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

availabilityEnablerSearchOrder - availability enabler search order

Throws:

NullArgumentException - availabilityEnablerSearchOrder is null

UnsupportedException - availabilityEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerSearchRecord

AvailabilityEnablerSearchRecord getAvailabilityEnablerSearchRecord(Type availabilityEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

availabilityEnablerSearchRecordType - an availability enabler search record type

Returns:

the availability enabler search record

Throws:

NullArgumentException - availabilityEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilityEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.