Interface | osid.authentication.keys.KeyQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Keys may have a query record indicated by their respective record types. The query record is accessed via the KeyQuery. | ||
Method | getAgencyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Agency Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgency | ||
Description |
Gets the | ||
Return | osid.authentication.Agency | the Agency associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchKeys | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedAgencyView | ||
Description |
Federates the view for methods in this session. A federated view will include keys in agencies which are children of this agency in the agency hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAgencyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this agency only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getKeyQuery | ||
Description |
Gets a key query. | ||
Return | osid.authentication.keys.KeyQuery | the key query | |
Compliance | mandatory | This method must be implemented. | |
Method | getKeysByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.authentication.keys.KeyQuery | keyQuery | the key query |
Return | osid.authentication.keys.KeyList | the returned KeyList | |
Errors | NULL_ARGUMENT | keyQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | keyQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |