Interface KeyAgencySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface KeyAgencySession
extends OsidSession

This session provides methods to retrieve Keys to Agency mappings. An Key may appear in multiple Agency objects. Each Agency 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	canLookupKeyAgencyMappings()	Tests if this user can perform lookups of key/agency mappings.
AgencyList	getAgenciesByKey(Id keyId)	Gets the list of Agency objects mapped to an Key .
IdList	getAgencyIdsByKey(Id keyId)	Gets the list of Agency Ids mapped to an Key .
IdList	getKeyIdsByAgencies(IdList agencyIds)	Gets the list of Key Ids corresponding to a list of Agency objects.
IdList	getKeyIdsByAgency(Id agencyId)	Gets the list of Key Ids associated with an Agency .
KeyList	getKeysByAgencies(IdList agencyIds)	Gets the list of Keys corresponding to a list of Agency objects.
KeyList	getKeysByAgency(Id agencyId)	Gets the list of Keys associated with an Agency .
void	useComparativeAgencyView()	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	usePlenaryAgencyView()	A complete view of the Key and Agency 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

canLookupKeyAgencyMappings

boolean canLookupKeyAgencyMappings()

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

useComparativeAgencyView

void useComparativeAgencyView()

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.

usePlenaryAgencyView

void usePlenaryAgencyView()

A complete view of the Key and Agency 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.

getKeyIdsByAgency

IdList getKeyIdsByAgency(Id agencyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Key Ids associated with an Agency .

Parameters:

agencyId - Id of the Agency

Returns:

list of related key Ids

Throws:

NotFoundException - agencyId is not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getKeysByAgency

KeyList getKeysByAgency(Id agencyId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Keys associated with an Agency .

Parameters:

agencyId - Id of the Agency

Returns:

list of related keys

Throws:

NotFoundException - agencyId is not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getKeyIdsByAgencies

IdList getKeyIdsByAgencies(IdList agencyIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Key Ids corresponding to a list of Agency objects.

Parameters:

agencyIds - list of agency Ids

Returns:

list of key Ids

Throws:

NullArgumentException - agencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getKeysByAgencies

KeyList getKeysByAgencies(IdList agencyIds)
                   throws OperationFailedException,
PermissionDeniedException

Gets the list of Keys corresponding to a list of Agency objects.

Parameters:

agencyIds - list of agency Ids

Returns:

list of keys

Throws:

NullArgumentException - agencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgencyIdsByKey

IdList getAgencyIdsByKey(Id keyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Agency Ids mapped to an Key .

Parameters:

keyId - Id of an Key

Returns:

list of agency Ids

Throws:

NotFoundException - keyId is not found

NullArgumentException - keyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgenciesByKey

AgencyList getAgenciesByKey(Id keyId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Agency objects mapped to an Key .

Parameters:

keyId - Id of an Key

Returns:

list of agencies

Throws:

NotFoundException - keyId is not found

NullArgumentException - keyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.