public interface StepProcessorSearch extends OsidSearch
The search interface for governing step processor searches.
Modifier and Type | Method and Description |
---|---|
StepProcessorSearchRecord |
getStepProcessorSearchRecord(Type stepProcessorSearchRecordType)
Gets the step processor search record corresponding to the given step
processor search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongStepProcessors(IdList officeIds)
officeIds
- list of step processorsNullArgumentException
- officeIds
is
null
mandatory
- This method must be implemented. void orderStepProcessorResults(StepProcessorSearchOrder stepProcessorSearchOrder)
stepProcessorSearchOrder
- step processor search orderNullArgumentException
- stepProcessorSearchOrder
is null
UnsupportedException
- stepProcessorSearchOrder
is not of this servicemandatory
- This method must be implemented. StepProcessorSearchRecord getStepProcessorSearchRecord(Type stepProcessorSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.stepProcessorSearchRecordType
- a step processor search record
typeNullArgumentException
-
stepProcessorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepProcessorSearchRecordType)
is
false
mandatory
- This method must be implemented.