Interface | osid.authorization.AuthorizationSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAuthorizations | ||
Description |
Gets the authorization list resulting from the search. | ||
Return | osid.authorization.AuthorizationList | the authorization list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.authorization.AuthorizationQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationSearchResultsRecord | ||
Description |
Gets the authorization search results record
corresponding to the given authorization search record
| ||
Parameters | osid.type.Type | authorizationSearchRecordType | an authorization search record type |
Return | osid.authorization.records.AuthorizationSearchResultsRecord | the authorization search results record | |
Errors | NULL_ARGUMENT | authorizationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(authorizationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |