org.osid.authorization

Interface VaultLookupSession

All Superinterfaces:

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

public interface VaultLookupSession
extends OsidSession

This session provides methods for retrieving Vault objects. The Vault represents a collection of Functions and Authorizations.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Vaults it can access, without breaking execution. However, an administrative application may require all Vault elements to be available.

Vaults may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Vault.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupVaults() Tests if this user can perform Vault lookups.
Vault	getVault(Id vaultId) Gets the Vault specified by its Id.
VaultList	getVaults() Gets all Vaults.
VaultList	getVaultsByGenusType(Type vaultGenusType) Gets a VaultList corresponding to the given vault genus Type which does not include vaults of types derived from the specified Type.
VaultList	getVaultsByIds(IdList vaultIds) Gets a VaultList corresponding to the given IdList.
VaultList	getVaultsByParentGenusType(Type vaultGenusType) Gets a VaultList corresponding to the given vault genus Type and include any additional vaults with genus types derived from the specified Type.
VaultList	getVaultsByProvider(Id resourceId) Gets a VaultList from the given provider .
VaultList	getVaultsByRecordType(Type vaultRecordType) Gets a VaultList containing the given vault record Type.
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 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

canLookupVaults

boolean canLookupVaults()

Tests if this user can perform Vault lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

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 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.

getVault

Vault getVault(Id vaultId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Vault specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Vault may have a different Id than requested, such as the case where a duplicate Id was assigned to a Vault and retained for compatibility.

Parameters:

vaultId - Id of the Vault

Returns:

the vault

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getVaultsByIds

VaultList getVaultsByIds(IdList vaultIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets a VaultList corresponding to the given IdList. In plenary mode, the returned list contains all of the vaults specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Vault objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

vaultIds - the list of Ids to retrieve

Returns:

the returned Vault list

Throws:

NotFoundException - an Id was not found

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByGenusType

VaultList getVaultsByGenusType(Type vaultGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a VaultList corresponding to the given vault genus Type which does not include vaults of types derived from the specified Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parameters:

vaultGenusType - a vault genus type

Returns:

the returned Vault list

Throws:

NullArgumentException - vaultGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByParentGenusType

VaultList getVaultsByParentGenusType(Type vaultGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a VaultList corresponding to the given vault genus Type and include any additional vaults with genus types derived from the specified Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parameters:

vaultGenusType - a vault genus type

Returns:

the returned Vault list

Throws:

NullArgumentException - vaultGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByRecordType

VaultList getVaultsByRecordType(Type vaultRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a VaultList containing the given vault record Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parameters:

vaultRecordType - a vault record type

Returns:

the returned Vault list

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByProvider

VaultList getVaultsByProvider(Id resourceId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a VaultList from the given provider . In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Vault list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaults

VaultList getVaults()
                    throws OperationFailedException,
                           PermissionDeniedException

Gets all Vaults. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Returns:

a VaultList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.