Interface ProgramSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProgramSearch
extends OsidSearch

The search interface for governing program searches.

Method Summary

Modifier and Type	Method	Description
ProgramSearchRecord	getProgramSearchRecord(Type programSearchRecordType)	Gets the program search record corresponding to the given program search record Type.
void	orderProgramResults(ProgramSearchOrder programSearchOrder)	Specify an ordering to the search results.
void	searchAmongPrograms(IdList programIds)	Execute this search among the given list of programs.

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

searchAmongPrograms

void searchAmongPrograms(IdList programIds)

Execute this search among the given list of programs.

Parameters:

programIds - list of program Ids

Throws:

NullArgumentException - programIds is null

Compliance:

mandatory - This method must be implemented.

orderProgramResults

void orderProgramResults(ProgramSearchOrder programSearchOrder)

Specify an ordering to the search results.

Parameters:

programSearchOrder - program search order

Throws:

NullArgumentException - programSearchOrder is null

UnsupportedException - programSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProgramSearchRecord

ProgramSearchRecord getProgramSearchRecord(Type programSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

programSearchRecordType - a program search record type

Returns:

the program search record

Throws:

NullArgumentException - programSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.