Interface StepProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepProcessorSearch
extends OsidSearch

The search interface for governing step processor searches.

Method Summary

Modifier and Type	Method	Description
StepProcessorSearchRecord	getStepProcessorSearchRecord(Type stepProcessorSearchRecordType)	Gets the step processor search record corresponding to the given step processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderStepProcessorResults(StepProcessorSearchOrder stepProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongStepProcessors(IdList officeIds)	Execute this search among the given list of step processors.

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

searchAmongStepProcessors

void searchAmongStepProcessors(IdList officeIds)

Execute this search among the given list of step processors.

Parameters:

officeIds - list of step processors

Throws:

NullArgumentException - officeIds is null

Compliance:

mandatory - This method must be implemented.

orderStepProcessorResults

void orderStepProcessorResults(StepProcessorSearchOrder stepProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

stepProcessorSearchOrder - step processor search order

Throws:

NullArgumentException - stepProcessorSearchOrder is null

UnsupportedException - stepProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepProcessorSearchRecord

StepProcessorSearchRecord getStepProcessorSearchRecord(Type stepProcessorSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

stepProcessorSearchRecordType - a step processor search record type

Returns:

the step processor search record

Throws:

NullArgumentException - stepProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.