org.osid.authorization

Interface AuthorizationVaultSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuthorizationVaultSession
extends OsidSession

This session provides methods to retrieve Authorization to Vault mappings. An Authorization may appear in multiple Vaults. Each Vault may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAuthorizationVaultMappings() Tests if this user can perform lookups of authorization/vault mappings.
IdList	getAuthorizationIdsByVault(Id vaultId) Gets the list of Authorization Ids associated with a Vault.
AuthorizationList	getAuthorizationsByVault(Id vaultId) Gets the list of Authorizations associated with a Vault.
AuthorizationList	getAuthorizationsByVault(IdList vaultIds) Gets the list of Authorizations corresponding to a list of Vault.
IdList	getAuthorizationsIdsByVault(IdList vaultIds) Gets the list of Authorization Ids corresponding to a list of Vault objects.
VaultList	getVaultByAuthorization(Id authorizationId) Gets the list of Vault objects mapped to an Authorization.
IdList	getVaultIdsByAuthorization(Id authorizationId) Gets the list of Vault Ids mapped to an Authorization.
void	useComparativeVaultView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryVaultView() A complete view of the Authorization and Vault returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

useComparativeVaultView

void useComparativeVaultView()

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.

usePlenaryVaultView

void usePlenaryVaultView()

A complete view of the Authorization and Vault returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

canLookupAuthorizationVaultMappings

boolean canLookupAuthorizationVaultMappings()

Tests if this user can perform lookups of authorization/vault 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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuthorizationIdsByVault

IdList getAuthorizationIdsByVault(Id vaultId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of Authorization Ids associated with a Vault.

Parameters:

vaultId - Id of a Vault

Returns:

list of related authorization Ids

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationsByVault

AuthorizationList getAuthorizationsByVault(Id vaultId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the list of Authorizations associated with a Vault.

Parameters:

vaultId - Id of a Vault

Returns:

list of related authorization

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationsIdsByVault

IdList getAuthorizationsIdsByVault(IdList vaultIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the list of Authorization Ids corresponding to a list of Vault objects.

Parameters:

vaultIds - list of vault Ids

Returns:

list of authorization Ids

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationsByVault

AuthorizationList getAuthorizationsByVault(IdList vaultIds)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the list of Authorizations corresponding to a list of Vault.

Parameters:

vaultIds - list of vault Ids

Returns:

list of authorizations

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultIdsByAuthorization

IdList getVaultIdsByAuthorization(Id authorizationId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of Vault Ids mapped to an Authorization.

Parameters:

authorizationId - Id of an Authorization

Returns:

list of vault Ids

Throws:

NotFoundException - authorizationId is not found

NullArgumentException - authorizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultByAuthorization

VaultList getVaultByAuthorization(Id authorizationId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of Vault objects mapped to an Authorization.

Parameters:

authorizationId - Id of an Authorization

Returns:

list of vault

Throws:

NotFoundException - authorizationId is not found

NullArgumentException - authorizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.