public interface CommitmentSearch extends OsidSearch
CommitmentSearch
defines the interface for specifying
commitment search options.
Modifier and Type | Method and Description |
---|---|
CommitmentSearchRecord |
getCommitmentSearchRecord(Type commitmentSearchRecordType)
Gets the commitment seaqrch record corresponding to the given
commitment search record
Type. |
void |
orderCommitmentResults(CommitmentSearchOrder commitmentSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCommitments(IdList commitmentIds)
Execute this search among the given list of commitments.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCommitments(IdList commitmentIds)
commitmentIds
- list of commitmentsNullArgumentException
- commitmentIds
is
null
mandatory
- This method must be implemented. void orderCommitmentResults(CommitmentSearchOrder commitmentSearchOrder)
commitmentSearchOrder
- commitment search orderNullArgumentException
- commitmentSearchOrder
is null
UnsupportedException
- commitmentSearchOrder
is not of this servicemandatory
- This method must be implemented. CommitmentSearchRecord getCommitmentSearchRecord(Type commitmentSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.commitmentSearchRecordType
- a commitment search record typeNullArgumentException
- commitmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentSearchRecordType)
is
false
mandatory
- This method must be implemented.