OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.QualifierVaultAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Qualifiers to Vaults. A Qualifier may map to multiple Vaults and removing the last reference to a Qualifier is the equivalent of deleting it. Each Vault may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Qualifier to another Vault is not a copy operation (eg: does not change its Id ).

MethodcanAssignQualifiers
Description

Tests if this user can alter qualifier/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignQualifiersToVault
Description

Tests if this user can alter qualifier/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdvaultIdthe Id of the Vault
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT vaultId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableVaultIds
Description

Gets a list of vault including and under the given vault node in which any qualifier can be assigned.

Parametersosid.id.IdvaultIdthe Id of the Vault
Returnosid.id.IdListlist of assignable vault Ids
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableVaultIdsForQualifier
Description

Gets a list of vault including and under the given vault node in which a specific qualifier can be assigned.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.id.IdqualifierIdthe Id of the Qualifier
Returnosid.id.IdListlist of assignable vault Ids
ErrorsNULL_ARGUMENT vaultId or qualifierId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQualifierToVault
Description

Adds an existing Qualifier to a Vault.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier
osid.id.IdvaultIdthe Id of the Vault
ErrorsALREADY_EXISTS qualifierId is already assigned to vaultId
NOT_FOUND qualifierId or vaultId not found
NULL_ARGUMENT qualifierId or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQualifierFromVault
Description

Removes a Qualifier from a Vault.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier
osid.id.IdvaultIdthe Id of the Vault
ErrorsNOT_FOUND qualifierId or vaultId not found or qualifierId not assigned to vaultId
NULL_ARGUMENT qualifierId or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignQualifierToVault
Description

Moves a Qualifier from one Vault to another. Mappings to other Vaults are unaffected.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier
osid.id.IdfromVaultIdthe Id of the current Vault
osid.id.IdtoVaultIdthe Id of the destination Vault
ErrorsNOT_FOUND qualfiierId, fromVaultId, or toVaultId not found or qualfiierId, not mapped to fromVaultId
NULL_ARGUMENT qualfiierId,, fromVaultId, or toVaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.