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

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

Moving or adding a reference of a Authorization to another Vault is not a copy operation (eg: does not change its Id ).

MethodcanAssignAuthorizations
Description

Tests if this user can alter authorization/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.
MethodcanAssignAuthorizationsToVault
Description

Tests if this user can alter authorization/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 authorization 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.
MethodgetAssignableVaultIdsForAuthorization
Description

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

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.id.IdauthorizationIdthe Id of the Authorization
Returnosid.id.IdListlist of assignable vault Ids
ErrorsNULL_ARGUMENT vaultId or authorizationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuthorizationToVault
Description

Adds an existing Authorization to a Vault.

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

Removes an Authorization from a Vault.

Parametersosid.id.IdauthorizationIdthe Id of the Authorization
osid.id.IdvaultIdthe Id of the Vault
ErrorsNOT_FOUND authorizationId or vaultId not found or authorizationId not assigned to vaultId
NULL_ARGUMENT authorizationId or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuthorizationToVault
Description

Moves an Authorization from one Vault to another. Mappings to other Vaults are unaffected.

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