Interface FunctionVaultSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FunctionVaultSession
extends OsidSession

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

This lookup session defines two 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

Modifier and Type	Method	Description
boolean	canLookupFunctionVaultMappings()	Tests if this user can perform lookups of function/vault mappings.
IdList	getFunctionIdsByVault(Id vaultId)	Gets the list of Function Ids associated with a Vault .
IdList	getFunctionIdsByVaults(IdList vaultIds)	Gets the list of Function Ids corresponding to a list of Vaults .
FunctionList	getFunctionsByVault(Id vaultId)	Gets the list of Functions associated with a Vault .
FunctionList	getFunctionsByVaults(IdList vaultIds)	Gets the list of Functions corresponding to a list of Vaults .
IdList	getVaultIdsByFunction(Id functionId)	Gets the list of Vault Ids mapped to a Function .
VaultList	getVaultsByFunction(Id functionId)	Gets the list of Vaults mapped to a Function .
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 Function and Vault returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupFunctionVaultMappings

boolean canLookupFunctionVaultMappings()

Tests if this user can perform lookups of function/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.

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

getFunctionIdsByVault

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

Gets the list of Function Ids associated with a Vault .

Parameters:

vaultId - Id of the Vault

Returns:

list of related function 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.

getFunctionsByVault

FunctionList getFunctionsByVault(Id vaultId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Functions associated with a Vault .

Parameters:

vaultId - Id of the Vault

Returns:

list of related functions

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.

getFunctionIdsByVaults

IdList getFunctionIdsByVaults(IdList vaultIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Function Ids corresponding to a list of Vaults .

Parameters:

vaultIds - list of vault Ids

Returns:

list of function Ids

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFunctionsByVaults

FunctionList getFunctionsByVaults(IdList vaultIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Functions corresponding to a list of Vaults .

Parameters:

vaultIds - list of vault Ids

Returns:

list of functions

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultIdsByFunction

IdList getVaultIdsByFunction(Id functionId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Vault Ids mapped to a Function .

Parameters:

functionId - Id of a Function

Returns:

list of vault Ids

Throws:

NotFoundException - functionId is not found

NullArgumentException - functionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByFunction

VaultList getVaultsByFunction(Id functionId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Vaults mapped to a Function .

Parameters:

functionId - Id of a Function

Returns:

list of vaults

Throws:

NotFoundException - functionId is not found

NullArgumentException - functionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.