| Interface | osid.calendaring.rules.CommitmentEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCommitmentEnablers | ||
| Description |
Gets the | ||
| Return | osid.calendaring.rules.CommitmentEnablerList | the commitment enabler list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommitmentEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.calendaring.rules.CommitmentEnablerQueryInspector | the commitment enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommitmentEnablerSearchResultsRecord | ||
| Description |
Gets the commitment enabler search results 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.CommitmentEnablerSearchResultsRecord | the commitment enabler search results record | |
| Errors | NULL_ARGUMENT | commitmentEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(commitmentEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |