Interface ProgramEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProgramEntrySearch
extends OsidSearch

The search interface for governing program entry searches.

Method Summary

Modifier and Type	Method	Description
ProgramEntrySearchRecord	getProgramEntrySearchRecord(Type programEntrySearchRecordType)	Gets the program entry search record corresponding to the given program entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProgramEntryResults(ProgramEntrySearchOrder programEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongProgramEntries(IdList programEntryIds)	Execute this search among the given list of program entries.

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

searchAmongProgramEntries

void searchAmongProgramEntries(IdList programEntryIds)

Execute this search among the given list of program entries.

Parameters:

programEntryIds - list of program entry Ids

Throws:

NullArgumentException - programEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderProgramEntryResults

void orderProgramEntryResults(ProgramEntrySearchOrder programEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

programEntrySearchOrder - program entry search order

Throws:

NullArgumentException - programEntrySearchOrder is null

UnsupportedException - programEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProgramEntrySearchRecord

ProgramEntrySearchRecord getProgramEntrySearchRecord(Type programEntrySearchRecordType)
                                              throws OperationFailedException

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

Parameters:

programEntrySearchRecordType - a program entry search record type

Returns:

the program entry search record

Throws:

NullArgumentException - programEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.