Interface | osid.authorization.AuthorizationSearchSession | ||
---|---|---|---|
Implements | osid.authorization.AuthorizationQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
| ||
Method | getAuthorizationSearch | ||
Description |
Gets an authorization search. | ||
Return | osid.authorization.AuthorizationSearch | the authorization search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationSearchOrder | ||
Description |
Gets an authorization search order. The | ||
Return | osid.authorization.AuthorizationSearchOrder | the authorization search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.authorization.AuthorizationQuery | authorizationQuery | the authorization query |
osid.authorization.AuthorizationSearch | authorizationSearch | the authorization search | |
Return | osid.authorization.AuthorizationSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | authorizationQuery or authorizationSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | authorizationSearch or authorizationQuery is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationQueryFromInspector | ||
Description |
Gets an authorization query from an inspector. The
inspector is available from an | ||
Parameters | osid.authorization.AuthorizationQueryInspector | authorizationQueryInspector | an authorization query inspector |
Return | osid.authorization.AuthorizationQuery | the authorization query | |
Errors | NULL_ARGUMENT | authorizationQueryInspector is null | |
UNSUPPORTED | authorizationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |