public interface StepSearch extends OsidSearch
The search interface for governing step searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSteps(IdList stepIds)
stepIds
- list of stepsNullArgumentException
- stepIds
is
null
mandatory
- This method must be implemented. void orderStepResults(StepSearchOrder stepSearchOrder)
stepSearchOrder
- step search orderNullArgumentException
- stepSearchOrder
is null
UnsupportedException
- stepSearchOrder
is not of this servicemandatory
- This method must be implemented. StepSearchRecord getStepSearchRecord(Type stepSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.stepSearchRecordType
- a step search record typeNullArgumentException
- stepSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepSearchRecordType)
is false
mandatory
- This method must be implemented.