Interface | osid.calendaring.CommitmentSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCommitments | ||
Description |
Gets the commitment list resulting from the search. | ||
Return | osid.calendaring.CommitmentList | the commitment list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.CommitmentQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentSearchResultsRecord | ||
Description |
Gets the commitment search results record corresponding
to the given commitment search record | ||
Parameters | osid.type.Type | commitmentSearchRecordType | a commitment search record type |
Return | osid.calendaring.records.CommitmentSearchResultsRecord | the commitment search results record | |
Errors | NULL_ARGUMENT | commitmentSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commitmentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |