public interface StepConstrainerSearch extends OsidSearch
The search interface for governing step constrainer searches.
Modifier and Type | Method and Description |
---|---|
StepConstrainerSearchRecord |
getStepConstrainerSearchRecord(Type stepConstrainerSearchRecordType)
Gets the step constrainer search record corresponding to the given
step constrainer search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongStepConstrainers(IdList officeIds)
officeIds
- list of step constrainersNullArgumentException
- officeIds
is
null
mandatory
- This method must be implemented. void orderStepConstrainerResults(StepConstrainerSearchOrder stepConstrainerSearchOrder)
stepConstrainerSearchOrder
- step constrainer search orderNullArgumentException
-
stepConstrainerSearchOrder
is null
UnsupportedException
-
stepConstrainerSearchOrder
is not of this servicemandatory
- This method must be implemented. StepConstrainerSearchRecord getStepConstrainerSearchRecord(Type stepConstrainerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.stepConstrainerSearchRecordType
- a step constrainer search
record typeNullArgumentException
-
stepConstrainerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepConstrainerSearchRecordType)
is
false
mandatory
- This method must be implemented.