Interface SequenceRuleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SequenceRuleSearch
extends OsidSearch

The search interface for governing sequence rule searches.

Method Summary

Modifier and Type	Method	Description
SequenceRuleSearchRecord	getSequenceRuleSearchRecord(Type sequenceRuleSearchRecordType)	Gets the sequence rule search record corresponding to the given sequence rule search record Type .This method is used to retrieve an object implementing the requested record.
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.

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

searchAmongSequenceRules

void searchAmongSequenceRules(IdList bankIds)

Execute this search among the given list of sequence rules.

Parameters:

bankIds - list of sequence rules

Throws:

NullArgumentException - bankIds is null

Compliance:

mandatory - This method must be implemented.

orderSequenceRuleResults

void orderSequenceRuleResults(SequenceRuleSearchOrder sequenceRuleSearchOrder)

Specify an ordering to the search results.

Parameters:

sequenceRuleSearchOrder - sequence rule search order

Throws:

NullArgumentException - sequenceRuleSearchOrder is null

UnsupportedException - sequenceRuleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSequenceRuleSearchRecord

SequenceRuleSearchRecord getSequenceRuleSearchRecord(Type sequenceRuleSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

sequenceRuleSearchRecordType - a sequence rule search record type

Returns:

the sequence rule search record

Throws:

NullArgumentException - sequenceRuleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sequenceRuleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.