Interface StepProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepProcessorEnablerSearch
extends OsidSearch

The search interface for governing step processor enabler searches.

Method Summary

Modifier and Type	Method	Description
StepProcessorEnablerSearchRecord	getStepProcessorEnablerSearchRecord(Type stepProcessorEnablerSearchRecordType)	Gets the step processor enabler search record corresponding to the given step processor enabler search record Type.
void	orderStepProcessorEnablerResults(StepProcessorEnablerSearchOrder stepProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongStepProcessorEnablers(IdList stepProcessorEnablerIds)	Execute this search among the given list of step processor 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

searchAmongStepProcessorEnablers

void searchAmongStepProcessorEnablers(IdList stepProcessorEnablerIds)

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

Parameters:

stepProcessorEnablerIds - list of step processor enablers

Throws:

NullArgumentException - stepProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderStepProcessorEnablerResults

void orderStepProcessorEnablerResults(StepProcessorEnablerSearchOrder stepProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

stepProcessorEnablerSearchOrder - step processor enabler search order

Throws:

NullArgumentException - stepProcessorEnablerSearchOrder is null

UnsupportedException - stepProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerSearchRecord

StepProcessorEnablerSearchRecord getStepProcessorEnablerSearchRecord(Type stepProcessorEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

stepProcessorEnablerSearchRecordType - a step processor enabler search record type

Returns:

the step processor enabler search record

Throws:

NullArgumentException - stepProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.