Interface QualifierVaultSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QualifierVaultSession
extends OsidSession

This session provides methods to retrieve Qualifier to Vault mappings. A Qualifier 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	canLookupQualifierVaultMappings()	Tests if this user can perform lookups of qualifier/vault mappings.
IdList	getQualifierIdsByVault(Id vaultId)	Gets the list of Qualifier Ids associated with a Vault .
IdList	getQualifierIdsByVaults(IdList vaultIds)	Gets the list of Qualifier Ids corresponding to a list of Vaults .
QualifierList	getQualifiersByVault(Id vaultId)	Gets the list of Qualifier associated with a Vault .
QualifierList	getQualifiersByVaults(IdList vaultIds)	Gets the list of Qualifiers corresponding to a list of Vaults .
IdList	getVaultIdsByQualifier(Id qualifierId)	Gets the list of Vault Ids mapped to a Qualifier .
VaultList	getVaultsByQualifier(Id qualifierId)	Gets the list of Vaults mapped to a Qualifier .
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 Qualifier 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

canLookupQualifierVaultMappings

boolean canLookupQualifierVaultMappings()

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

getQualifierIdsByVault

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

Gets the list of Qualifier Ids associated with a Vault .

Parameters:

vaultId - Id of the Vault

Returns:

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

getQualifiersByVault

QualifierList getQualifiersByVault(Id vaultId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Qualifier associated with a Vault .

Parameters:

vaultId - Id of the Vault

Returns:

list of related qualifiers

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.

getQualifierIdsByVaults

IdList getQualifierIdsByVaults(IdList vaultIds)
                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

vaultIds - list of vault Ids

Returns:

list of vault Ids

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQualifiersByVaults

QualifierList getQualifiersByVaults(IdList vaultIds)
                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

vaultIds - list of vault Ids

Returns:

list of qualifiers

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultIdsByQualifier

IdList getVaultIdsByQualifier(Id qualifierId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Vault Ids mapped to a Qualifier .

Parameters:

qualifierId - Id of a Qualifier

Returns:

list of vault Ids

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultsByQualifier

VaultList getVaultsByQualifier(Id qualifierId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Vaults mapped to a Qualifier .

Parameters:

qualifierId - Id of a Qualifier

Returns:

list of vaults

Throws:

NotFoundException - qualifierId is not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.