Interface CommitmentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CommitmentSearch
extends OsidSearch

CommitmentSearch defines the interface for specifying commitment search options.

Method Summary

Modifier and Type	Method	Description
CommitmentSearchRecord	getCommitmentSearchRecord(Type commitmentSearchRecordType)	Gets the commitment seaqrch record corresponding to the given commitment search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCommitmentResults(CommitmentSearchOrder commitmentSearchOrder)	Specify an ordering to the search results.
void	searchAmongCommitments(IdList commitmentIds)	Execute this search among the given list of commitments.

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

searchAmongCommitments

void searchAmongCommitments(IdList commitmentIds)

Execute this search among the given list of commitments.

Parameters:

commitmentIds - list of commitments

Throws:

NullArgumentException - commitmentIds is null

Compliance:

mandatory - This method must be implemented.

orderCommitmentResults

void orderCommitmentResults(CommitmentSearchOrder commitmentSearchOrder)

Specify an ordering to the search results.

Parameters:

commitmentSearchOrder - commitment search order

Throws:

NullArgumentException - commitmentSearchOrder is null

UnsupportedException - commitmentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCommitmentSearchRecord

CommitmentSearchRecord getCommitmentSearchRecord(Type commitmentSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

commitmentSearchRecordType - a commitment search record type

Returns:

the commitment search record

Throws:

NullArgumentException - commitmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.