Interface SequenceRuleEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SequenceRuleEnablerSearch
extends OsidSearch

The search interface for governing sequence rule enabler searches.

Method Summary

Modifier and Type	Method	Description
SequenceRuleEnablerSearchRecord	getSequenceRuleEnablerSearchRecord(Type sequenceRuleEnablerSearchRecordType)	Gets the sequence rule enabler search record corresponding to the given sequence rule enabler search record Type .
void	orderSequenceRuleEnablerResults(SequenceRuleEnablerSearchOrder sequenceRuleEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongSequenceRuleEnablers(IdList sequenceRuleEnablerIds)	Execute this search among the given list of sequence rule enablers.

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

searchAmongSequenceRuleEnablers

void searchAmongSequenceRuleEnablers(IdList sequenceRuleEnablerIds)

Execute this search among the given list of sequence rule enablers.

Parameters:

sequenceRuleEnablerIds - list of sequence rule enablers

Throws:

NullArgumentException - sequenceRuleEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderSequenceRuleEnablerResults

void orderSequenceRuleEnablerResults(SequenceRuleEnablerSearchOrder sequenceRuleEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

sequenceRuleEnablerSearchOrder - sequence rule enabler search order

Throws:

NullArgumentException - sequenceRuleEnablerSearchOrder is null

UnsupportedException - sequenceRuleEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablerSearchRecord

SequenceRuleEnablerSearchRecord getSequenceRuleEnablerSearchRecord(Type sequenceRuleEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

sequenceRuleEnablerSearchRecordType - a sequence rule enabler search record type

Returns:

the sequence rule enabler search record

Throws:

NullArgumentException - sequenceRuleEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sequenceRuleEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.