Interface ObjectiveSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ObjectiveSearch
extends OsidSearch

ObjectiveSearch defines the interface for specifying objective search options.

Method Summary

Modifier and Type	Method	Description
ObjectiveSearchRecord	getObjectiveSearchRecord(Type objectiveSearchRecordType)	Gets the objective search record corresponding to the given objective search record Type.
void	orderObjectiveResults(ObjectiveSearchOrder objectiveSearchOrder)	Specify an ordering to the search results.
void	searchAmongObjectives(IdList objectiveIds)	Execute this search among the given list of objectives.

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

searchAmongObjectives

void searchAmongObjectives(IdList objectiveIds)

Execute this search among the given list of objectives.

Parameters:

objectiveIds - list of objectives

Throws:

NullArgumentException - objectiveIds is null

Compliance:

mandatory - This method must be implemented.

orderObjectiveResults

void orderObjectiveResults(ObjectiveSearchOrder objectiveSearchOrder)

Specify an ordering to the search results.

Parameters:

objectiveSearchOrder - objective search order

Throws:

NullArgumentException - objectiveSearchOrder is null

UnsupportedException - objectiveSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getObjectiveSearchRecord

ObjectiveSearchRecord getObjectiveSearchRecord(Type objectiveSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

objectiveSearchRecordType - an objective search record type

Returns:

the objective search record

Throws:

NullArgumentException - objectiveSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasSearchRecordType(objectiveSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.