Interface | osid.authorization.QualifierLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving qualifiers. This lookup session defines several views:
The methods | ||
Method | getVaultId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Vault Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getVault | ||
Description |
Gets the | ||
Return | osid.authorization.Vault | the Vault associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupQualifiers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeQualifierView | ||
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 | usePlenaryQualifierView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedVaultView | ||
Description |
Federates the view for methods in this session. A federated view will include qualifiers in vaults which are children of this vault in the vault hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedVaultView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this vault only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQualifier | ||
Description |
Gets the | ||
Parameters | osid.id.Id | qualifierId | Id of the Qualifier |
Return | osid.authorization.Qualifier | the qualifier | |
Errors | NOT_FOUND | qualifierId not found | |
NULL_ARGUMENT | qualifierId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQualifiersByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | qualifierIds | the list of Ids to retrieve |
Return | osid.authorization.QualifierList | the returned Qualifier list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | qualifierIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQualifiersByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | qualifierGenusType | a qualifier genus type |
Return | osid.authorization.QualifierList | the returned Qualifier list | |
Errors | NULL_ARGUMENT | qualifierGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQualifiersByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | qualifierGenusType | a qualifier genus type |
Return | osid.authorization.QualifierList | the returned Qualifier list | |
Errors | NULL_ARGUMENT | qualifierGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQualifiersByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | qualifierRecordType | a qualifier record type |
Return | osid.authorization.QualifierList | the returned Qualifier list | |
Errors | NULL_ARGUMENT | qualifierRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQualifiers | ||
Description |
Gets all | ||
Return | osid.authorization.QualifierList | a list of Qualifiers | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |