Interface ProgramOfferingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProgramOfferingSearch
extends OsidSearch

The search interface for governing program offering searches.

Method Summary

Modifier and Type	Method	Description
ProgramOfferingSearchRecord	getProgramOfferingSearchRecord(Type programOfferingSearchRecordType)	Gets the program offering search record corresponding to the given program offering search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProgramOfferingResults(ProgramOfferingSearchOrder programOfferingSearchOrder)	Specify an ordering to the search results.
void	searchAmongProgramOfferings(IdList programOfferingIds)	Execute this search among the given list of program 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

searchAmongProgramOfferings

void searchAmongProgramOfferings(IdList programOfferingIds)

Execute this search among the given list of program offerings.

Parameters:

programOfferingIds - list of program offering Ids

Throws:

NullArgumentException - programOfferingIds is null

Compliance:

mandatory - This method must be implemented.

orderProgramOfferingResults

void orderProgramOfferingResults(ProgramOfferingSearchOrder programOfferingSearchOrder)

Specify an ordering to the search results.

Parameters:

programOfferingSearchOrder - program search order

Throws:

NullArgumentException - programOfferingSearchOrder is null

UnsupportedException - programOfferingSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProgramOfferingSearchRecord

ProgramOfferingSearchRecord getProgramOfferingSearchRecord(Type programOfferingSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

programOfferingSearchRecordType - a program search record type

Returns:

the program offering search record

Throws:

NullArgumentException - programOfferingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.