Interface | osid.authentication.keys.KeyAgencySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines two views:
| ||
Method | canLookupKeyAgencyMappings | ||
Description |
Tests if this user can perform lookups of key/agency
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAgencyView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryAgencyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getKeyIdsByAgency | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | agencyId | Id of the Agency |
Return | osid.id.IdList | list of related key Ids | |
Errors | NOT_FOUND | agencyId is not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getKeysByAgency | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | agencyId | Id of the Agency |
Return | osid.authentication.keys.KeyList | list of related keys | |
Errors | NOT_FOUND | agencyId is not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getKeyIdsByAgencies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | agencyIds | list of agency Ids |
Return | osid.id.IdList | list of key Ids | |
Errors | NULL_ARGUMENT | agencyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getKeysByAgencies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | agencyIds | list of agency Ids |
Return | osid.authentication.keys.KeyList | list of keys | |
Errors | NULL_ARGUMENT | agencyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgencyIdsByKey | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | keyId | Id of an Key |
Return | osid.id.IdList | list of agency Ids | |
Errors | NOT_FOUND | keyId is not found | |
NULL_ARGUMENT | keyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgenciesByKey | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | keyId | Id of an Key |
Return | osid.authentication.AgencyList | list of agencies | |
Errors | NOT_FOUND | keyId is not found | |
NULL_ARGUMENT | keyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |