Interface | osid.calendaring.CommitmentSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongCommitments | ||
Description |
Execute this search among the given list of commitments. | ||
Parameters | osid.id.IdList | commitmentIds | list of commitments |
Errors | NULL_ARGUMENT | commitmentIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCommitmentResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.CommitmentSearchOrder | commitmentSearchOrder | commitment search order |
Errors | NULL_ARGUMENT | commitmentSearchOrder is null | |
UNSUPPORTED | commitmentSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentSearchRecord | ||
Description |
Gets the commitment seaqrch record corresponding to the
given commitment search record | ||
Parameters | osid.type.Type | commitmentSearchRecordType | a commitment search record type |
Return | osid.calendaring.records.CommitmentSearchRecord | the commitment search record | |
Errors | NULL_ARGUMENT | commitmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commitmentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |