Interface StepSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StepSearch
extends OsidSearch

The search interface for governing step searches.

Method Summary

Modifier and Type	Method	Description
StepSearchRecord	getStepSearchRecord(Type stepSearchRecordType)	Gets the step search record corresponding to the given step search record Type.
void	orderStepResults(StepSearchOrder stepSearchOrder)	Specify an ordering to the search results.
void	searchAmongSteps(IdList stepIds)	Execute this search among the given list of steps.

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

searchAmongSteps

void searchAmongSteps(IdList stepIds)

Execute this search among the given list of steps.

Parameters:

stepIds - list of steps

Throws:

NullArgumentException - stepIds is null

Compliance:

mandatory - This method must be implemented.

orderStepResults

void orderStepResults(StepSearchOrder stepSearchOrder)

Specify an ordering to the search results.

Parameters:

stepSearchOrder - step search order

Throws:

NullArgumentException - stepSearchOrder is null

UnsupportedException - stepSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStepSearchRecord

StepSearchRecord getStepSearchRecord(Type stepSearchRecordType)
                              throws OperationFailedException

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

Parameters:

stepSearchRecordType - a step search record type

Returns:

the step search record

Throws:

NullArgumentException - stepSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.