Interface TextPressSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TextPressSession
extends OsidSession

This session provides methods to retrieve Text to Press mappings. A Text 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	canLookupTextPressMappings()	Tests if this user can perform lookups of text/press mappings.
PressList	getPressesByText(Id textId)	Gets the Presses mapped to a Text .
IdList	getPressIdsByText(Id textId)	Gets the Press Ids mapped to a Text .
IdList	getTextIdsByPress(Id pressId)	Gets the list of Text Ids associated with a Press .
IdList	getTextIdsByPresses(IdList pressIds)	Gets the list of Text Ids corresponding to a list of Presses .
TextList	getTextsByPress(Id pressId)	Gets the list of Texts associated with a Press .
TextList	getTextsByPresses(IdList pressIds)	Gets the list of Text corresponding to a list of Presses .
void	useComparativeTextPressView()	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	usePlenaryTextPressView()	A complete view of the Text 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

canLookupTextPressMappings

boolean canLookupTextPressMappings()

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

useComparativeTextPressView

void useComparativeTextPressView()

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.

usePlenaryTextPressView

void usePlenaryTextPressView()

A complete view of the Text 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.

getTextIdsByPress

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

Gets the list of Text Ids associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

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

getTextsByPress

TextList getTextsByPress(Id pressId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Texts associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

list of related texts

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.

getTextIdsByPresses

IdList getTextIdsByPresses(IdList pressIds)
                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pressIds - list of press Ids

Returns:

list of text Ids

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTextsByPresses

TextList getTextsByPresses(IdList pressIds)
                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pressIds - list of press Ids

Returns:

list of texts

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressIdsByText

IdList getPressIdsByText(Id textId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Press Ids mapped to a Text .

Parameters:

textId - Id of a Text

Returns:

list of presses

Throws:

NotFoundException - textId is not found

NullArgumentException - textId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressesByText

PressList getPressesByText(Id textId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Presses mapped to a Text .

Parameters:

textId - Id of a Text

Returns:

list of presses

Throws:

NotFoundException - textId is not found

NullArgumentException - textId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.