Interface StepConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepConstrainerSearch
extends OsidSearch

The search interface for governing step constrainer searches.

Method Summary

Modifier and Type	Method	Description
StepConstrainerSearchRecord	getStepConstrainerSearchRecord(Type stepConstrainerSearchRecordType)	Gets the step constrainer search record corresponding to the given step constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderStepConstrainerResults(StepConstrainerSearchOrder stepConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongStepConstrainers(IdList officeIds)	Execute this search among the given list of step constrainers.

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

searchAmongStepConstrainers

void searchAmongStepConstrainers(IdList officeIds)

Execute this search among the given list of step constrainers.

Parameters:

officeIds - list of step constrainers

Throws:

NullArgumentException - officeIds is null

Compliance:

mandatory - This method must be implemented.

orderStepConstrainerResults

void orderStepConstrainerResults(StepConstrainerSearchOrder stepConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

stepConstrainerSearchOrder - step constrainer search order

Throws:

NullArgumentException - stepConstrainerSearchOrder is null

UnsupportedException - stepConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepConstrainerSearchRecord

StepConstrainerSearchRecord getStepConstrainerSearchRecord(Type stepConstrainerSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

stepConstrainerSearchRecordType - a step constrainer search record type

Returns:

the step constrainer search record

Throws:

NullArgumentException - stepConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.