Interface IdiomPressSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IdiomPressSession
extends OsidSession

This session provides methods to retrieve Idiom to Press mappings. An Idiom 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	canLookupIdiomPressMappings()	Tests if this user can perform lookups of idiom/press mappings.
IdList	getIdiomIdsByPress(Id pressId)	Gets the list of Idiom Ids associated with a Press .
IdList	getIdiomIdsByPresses(IdList pressIds)	Gets the list of Idiom Ids corresponding to a list of Presses .
IdiomList	getIdiomsByPress(Id pressId)	Gets the list of Idioms associated with a Press .
IdiomList	getIdiomsByPresses(IdList pressIds)	Gets the list of Idiom corresponding to a list of Presses .
PressList	getPressesByIdiom(Id idiomId)	Gets the Presses mapped to an Idiom .
IdList	getPressIdsByIdiom(Id idiomId)	Gets the Press Ids mapped to an Idiom .
void	useComparativeIdiomPressView()	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	usePlenaryIdiomPressView()	A complete view of the Idiom 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

canLookupIdiomPressMappings

boolean canLookupIdiomPressMappings()

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

useComparativeIdiomPressView

void useComparativeIdiomPressView()

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.

usePlenaryIdiomPressView

void usePlenaryIdiomPressView()

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

getIdiomIdsByPress

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

Gets the list of Idiom Ids associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

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

getIdiomsByPress

IdiomList getIdiomsByPress(Id pressId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Idioms associated with a Press .

Parameters:

pressId - Id of the Press

Returns:

list of related idioms

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.

getIdiomIdsByPresses

IdList getIdiomIdsByPresses(IdList pressIds)
                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pressIds - list of press Ids

Returns:

list of idiom Ids

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIdiomsByPresses

IdiomList getIdiomsByPresses(IdList pressIds)
                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pressIds - list of press Ids

Returns:

list of idioms

Throws:

NullArgumentException - pressIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressIdsByIdiom

IdList getPressIdsByIdiom(Id idiomId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Press Ids mapped to an Idiom .

Parameters:

idiomId - Id of an Idiom

Returns:

list of presses

Throws:

NotFoundException - idiomId is not found

NullArgumentException - idiomId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressesByIdiom

PressList getPressesByIdiom(Id idiomId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Presses mapped to an Idiom .

Parameters:

idiomId - Id of an Idiom

Returns:

list of presses

Throws:

NotFoundException - idiomId is not found

NullArgumentException - idiomId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.