Interface OfferingConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OfferingConstrainerSearch
extends OsidSearch

The search interface for governing offering constrainer searches.

Method Summary

Modifier and Type	Method	Description
OfferingConstrainerSearchRecord	getOfferingConstrainerSearchRecord(Type offeringConstrainerSearchRecordType)	Gets the offering constrainer search record corresponding to the given offering constrainer search record Type .
void	orderOfferingConstrainerResults(OfferingConstrainerSearchOrder offeringConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongOfferingConstrainers(IdList offeringConstrainerIds)	Execute this search among the given list of offering constrainers.

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

searchAmongOfferingConstrainers

void searchAmongOfferingConstrainers(IdList offeringConstrainerIds)

Execute this search among the given list of offering constrainers.

Parameters:

offeringConstrainerIds - list of offering constrainers

Throws:

NullArgumentException - offeringConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderOfferingConstrainerResults

void orderOfferingConstrainerResults(OfferingConstrainerSearchOrder offeringConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

offeringConstrainerSearchOrder - offering constrainer search order

Throws:

NullArgumentException - offeringConstrainerSearchOrder is null

UnsupportedException - offeringConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerSearchRecord

OfferingConstrainerSearchRecord getOfferingConstrainerSearchRecord(Type offeringConstrainerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

offeringConstrainerSearchRecordType - an offering constrainer search record type

Returns:

the offering constrainer search record

Throws:

NullArgumentException - offeringConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offeringConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.