Interface ParameterPressSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParameterPressSession
extends OsidSession

This session provides methods to retrieve Parameter to Press mappings. A Parameter may appear in multiple Press objects. Each press 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

Modifier and Type	Method	Description
boolean	canLookupParameterPressMappings()	Tests if this user can perform lookups of parameter/press mappings.
IdList	getParameterIdsByPress(Id pressId)	Gets the list of Parameter Ids associated with a Press .
IdList	getParameterIdsByPresses(IdList pressIds)	Gets the list of Parameter Ids corresponding to a list of Presses .
ParameterList	getParametersByPress(Id pressId)	Gets the list of parameters associated with a Press .
ParameterList	getParametersByPresses(IdList pressIds)	Gets the list of parameters corresponding to a list of Presses .
PressList	getPressesByParameter(Id parameterId)	Gets the Presses mapped to a Parameter .
IdList	getPressIdsByParameter(Id parameterId)	Gets the Press Ids mapped to a Parameter .
void	useComparativeParameterPressView()	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	usePlenaryParameterPressView()	A complete view of the Parameter and Press 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

canLookupParameterPressMappings

boolean canLookupParameterPressMappings()

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

useComparativeParameterPressView

void useComparativeParameterPressView()

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.

usePlenaryParameterPressView

void usePlenaryParameterPressView()

A complete view of the Parameter and Press 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.

getParameterIdsByPress

IdList getParameterIdsByPress(Id pressId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Parameter Ids associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

list of related parameter Ids

Throws:

NotFoundException - pressId is not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParametersByPress

ParameterList getParametersByPress(Id pressId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of parameters associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

list of related parameters

Throws:

NotFoundException - pressId is not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterIdsByPresses

IdList getParameterIdsByPresses(IdList pressIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Parameter Ids corresponding to a list of Presses .

Parameters:

pressIds - list of press Ids

Returns:

list of parameter Ids

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParametersByPresses

ParameterList getParametersByPresses(IdList pressIds)
                              throws OperationFailedException,
PermissionDeniedException

Gets the list of parameters corresponding to a list of Presses .

Parameters:

pressIds - list of press Ids

Returns:

list of parameters

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressIdsByParameter

IdList getPressIdsByParameter(Id parameterId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Press Ids mapped to a Parameter .

Parameters:

parameterId - Id of a Parameter

Returns:

list of presses

Throws:

NotFoundException - parameterId is not found

NullArgumentException - parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressesByParameter

PressList getPressesByParameter(Id parameterId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Presses mapped to a Parameter .

Parameters:

parameterId - Id of a Parameter

Returns:

list of presses

Throws:

NotFoundException - parameterId is not found

NullArgumentException - parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.