Interface OfferingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OfferingSearch
extends OsidSearch

The search interface for governing offering searches.

Method Summary

Modifier and Type	Method	Description
OfferingSearchRecord	getOfferingSearchRecord(Type offeringSearchRecordType)	Gets the record corresponding to the given offering search record Type .
void	orderOfferingResults(OfferingSearchOrder offeringSearchOrder)	Specify an ordering to the search results.
void	searchAmongOfferings(IdList offeringIds)	Execute this search among the given list of offerings.

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

searchAmongOfferings

void searchAmongOfferings(IdList offeringIds)

Execute this search among the given list of offerings.

Parameters:

offeringIds - list of offerings

Throws:

NullArgumentException - offeringIds is null

Compliance:

mandatory - This method must be implemented.

orderOfferingResults

void orderOfferingResults(OfferingSearchOrder offeringSearchOrder)

Specify an ordering to the search results.

Parameters:

offeringSearchOrder - offering search order

Throws:

NullArgumentException - offeringSearchOrder is null

UnsupportedException - offeringSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOfferingSearchRecord

OfferingSearchRecord getOfferingSearchRecord(Type offeringSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

offeringSearchRecordType - an offering search record type

Returns:

the offering search record

Throws:

NullArgumentException - offeringSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offeringSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.