Interface StepEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepEnablerSearch
extends OsidSearch

The search interface for governing step enabler searches.

Method Summary

Modifier and Type	Method	Description
StepEnablerSearchRecord	getStepEnablerSearchRecord(Type stepEnablerSearchRecordType)	Gets the step enabler search record corresponding to the given step enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderStepEnablerResults(StepEnablerSearchOrder stepEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongStepEnablers(IdList stepEnablerIds)	Execute this search among the given list of step 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

searchAmongStepEnablers

void searchAmongStepEnablers(IdList stepEnablerIds)

Execute this search among the given list of step enablers.

Parameters:

stepEnablerIds - list of step enablers

Throws:

NullArgumentException - stepEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderStepEnablerResults

void orderStepEnablerResults(StepEnablerSearchOrder stepEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

stepEnablerSearchOrder - step enabler search order

Throws:

NullArgumentException - stepEnablerSearchOrder is null

UnsupportedException - stepEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepEnablerSearchRecord

StepEnablerSearchRecord getStepEnablerSearchRecord(Type stepEnablerSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

stepEnablerSearchRecordType - a step enabler search record type

Returns:

the step enabler search record

Throws:

NullArgumentException - stepEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.