public interface CommitmentEnablerSearch extends OsidSearch
The search interface for governing commitment enabler searches.
Modifier and Type | Method and Description |
---|---|
CommitmentEnablerSearchRecord |
getCommitmentEnablerSearchRecord(Type commitmentEnablerSearchRecordType)
Gets the commitment enabler search record corresponding to the given
commitment enabler search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCommitmentEnablers(IdList commitmentEnablerIds)
commitmentEnablerIds
- list of commitment enablersNullArgumentException
- commitmentEnablerIds
is null
mandatory
- This method must be implemented. void orderCommitmentEnablerResults(CommitmentEnablerSearchOrder commitmentEnablerSearchOrder)
commitmentEnablerSearchOrder
- commitment enabler search orderNullArgumentException
-
commitmentEnablerSearchOrder
is null
UnsupportedException
-
commitmentEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. CommitmentEnablerSearchRecord getCommitmentEnablerSearchRecord(Type commitmentEnablerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.commitmentEnablerSearchRecordType
- a commitment enabler search
record typeNullArgumentException
-
commitmentEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.