Interface StepConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepConstrainerEnablerSearch
extends OsidSearch

The search interface for governing step constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
StepConstrainerEnablerSearchRecord	getStepConstrainerEnablerSearchRecord(Type stepConstrainerEnablerSearchRecordType)	Gets the step constrainer enabler search record corresponding to the given step constrainer enabler search record Type .
void	orderStepConstrainerEnablerResults(StepConstrainerEnablerSearchOrder stepConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongStepConstrainerEnablers(IdList stepConstrainerEnablerIds)	Execute this search among the given list of step constrainer enablers.

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

searchAmongStepConstrainerEnablers

void searchAmongStepConstrainerEnablers(IdList stepConstrainerEnablerIds)

Execute this search among the given list of step constrainer enablers.

Parameters:

stepConstrainerEnablerIds - list of step constrainer enablers

Throws:

NullArgumentException - stepConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderStepConstrainerEnablerResults

void orderStepConstrainerEnablerResults(StepConstrainerEnablerSearchOrder stepConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

stepConstrainerEnablerSearchOrder - step constrainer enabler search order

Throws:

NullArgumentException - stepConstrainerEnablerSearchOrder is null

UnsupportedException - stepConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerSearchRecord

StepConstrainerEnablerSearchRecord getStepConstrainerEnablerSearchRecord(Type stepConstrainerEnablerSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

stepConstrainerEnablerSearchRecordType - a step constrainer enabler search record type

Returns:

the step constrainer enabler search record

Throws:

NullArgumentException - stepConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.