Interface PlanSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PlanSearch
extends OsidSearch

The search interface for governing plan searches.

Method Summary

Modifier and Type	Method	Description
PlanSearchRecord	getPlanSearchRecord(Type planSearchRecordType)	Gets the plan search record corresponding to the given plan search record Type.
void	orderPlanResults(PlanSearchOrder planSearchOrder)	Specify an ordering to the search results.
void	searchAmongPlans(IdList planIds)	Execute this search among the given list of plans.

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

searchAmongPlans

void searchAmongPlans(IdList planIds)

Execute this search among the given list of plans.

Parameters:

planIds - list of plans

Throws:

NullArgumentException - planIds is null

Compliance:

mandatory - This method must be implemented.

orderPlanResults

void orderPlanResults(PlanSearchOrder planSearchOrder)

Specify an ordering to the search results.

Parameters:

planSearchOrder - plan search order

Throws:

NullArgumentException - planSearchOrder is null

UnsupportedException - planSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPlanSearchRecord

PlanSearchRecord getPlanSearchRecord(Type planSearchRecordType)
                              throws OperationFailedException

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

Parameters:

planSearchRecordType - a plan search record type

Returns:

the plan search record

Throws:

NullArgumentException - planSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.