Interface CommitmentEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CommitmentEnablerSearch
extends OsidSearch

The search interface for governing commitment enabler searches.

Method Summary

Modifier and Type	Method	Description
CommitmentEnablerSearchRecord	getCommitmentEnablerSearchRecord(Type commitmentEnablerSearchRecordType)	Gets the commitment enabler search record corresponding to the given commitment enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCommitmentEnablerResults(CommitmentEnablerSearchOrder commitmentEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCommitmentEnablers(IdList commitmentEnablerIds)	Execute this search among the given list of commitment 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

searchAmongCommitmentEnablers

void searchAmongCommitmentEnablers(IdList commitmentEnablerIds)

Execute this search among the given list of commitment enablers.

Parameters:

commitmentEnablerIds - list of commitment enablers

Throws:

NullArgumentException - commitmentEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderCommitmentEnablerResults

void orderCommitmentEnablerResults(CommitmentEnablerSearchOrder commitmentEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

commitmentEnablerSearchOrder - commitment enabler search order

Throws:

NullArgumentException - commitmentEnablerSearchOrder is null

UnsupportedException - commitmentEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerSearchRecord

CommitmentEnablerSearchRecord getCommitmentEnablerSearchRecord(Type commitmentEnablerSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

commitmentEnablerSearchRecordType - a commitment enabler search record type

Returns:

the commitment enabler search record

Throws:

NullArgumentException - commitmentEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.