Interface InstructionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InstructionSearch
extends OsidSearch

The search interface for governing instruction searches.

Method Summary

Modifier and Type	Method	Description
InstructionSearchRecord	getInstructionSearchRecord(Type instructionSearchRecordType)	Gets the instruction search record corresponding to the given instruction search record Type .This method is used to retrieve an object implementing the requested record.
void	orderInstructionResults(InstructionSearchOrder instructionSearchOrder)	Specify an ordering to the search results.
void	searchAmongInstructions(IdList instructionIds)	Execute this search among the given list of instructions.

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

searchAmongInstructions

void searchAmongInstructions(IdList instructionIds)

Execute this search among the given list of instructions.

Parameters:

instructionIds - list of instructions

Throws:

NullArgumentException - instructionIds is null

Compliance:

mandatory - This method must be implemented.

orderInstructionResults

void orderInstructionResults(InstructionSearchOrder instructionSearchOrder)

Specify an ordering to the search results.

Parameters:

instructionSearchOrder - instruction search order

Throws:

NullArgumentException - instructionSearchOrder is null

UnsupportedException - instructionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInstructionSearchRecord

InstructionSearchRecord getInstructionSearchRecord(Type instructionSearchRecordType)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

instructionSearchRecordType - an instruction search record type

Returns:

the instruction search record

Throws:

NullArgumentException - instructionSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.