Interface | osid.calendaring.rules.CommitmentEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing commitment enabler searches. | ||
Method | searchAmongCommitmentEnablers | ||
Description |
Execute this search among the given list of commitment enablers. | ||
Parameters | osid.id.IdList | commitmentEnablerIds | list of commitment enablers |
Errors | NULL_ARGUMENT | commitmentEnablerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCommitmentEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.rules.CommitmentEnablerSearchOrder | commitmentEnablerSearchOrder | commitment enabler search order |
Errors | NULL_ARGUMENT | commitmentEnablerSearchOrder is null | |
UNSUPPORTED | commitmentEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablerSearchRecord | ||
Description |
Gets the commitment enabler search record corresponding
to the given commitment enabler search record | ||
Parameters | osid.type.Type | commitmentEnablerSearchRecordType | a commitment enabler search record type |
Return | osid.calendaring.rules.records.CommitmentEnablerSearchRecord | the commitment enabler search record | |
Errors | NULL_ARGUMENT | commitmentEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commitmentEnablerSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |