public interface SequenceRuleSearch extends OsidSearch
The search interface for governing sequence rule searches.
Modifier and Type | Method and Description |
---|---|
SequenceRuleSearchRecord |
getSequenceRuleSearchRecord(Type sequenceRuleSearchRecordType)
Gets the sequence rule search record corresponding to the given
sequence rule search record
Type. |
void |
orderSequenceRuleResults(SequenceRuleSearchOrder sequenceRuleSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSequenceRules(IdList bankIds)
Execute this search among the given list of sequence rules.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSequenceRules(IdList bankIds)
bankIds
- list of sequence rulesNullArgumentException
- bankIds
is
null
mandatory
- This method must be implemented. void orderSequenceRuleResults(SequenceRuleSearchOrder sequenceRuleSearchOrder)
sequenceRuleSearchOrder
- sequence rule search orderNullArgumentException
- sequenceRuleSearchOrder
is null
UnsupportedException
- sequenceRuleSearchOrder
is not of this servicemandatory
- This method must be implemented. SequenceRuleSearchRecord getSequenceRuleSearchRecord(Type sequenceRuleSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.sequenceRuleSearchRecordType
- a sequence rule search record
typeNullArgumentException
-
sequenceRuleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sequenceRuleSearchRecordType)
is
false
mandatory
- This method must be implemented.