Interface IdiomPressAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IdiomPressAssignmentSession
extends OsidSession

This session provides methods to re-assign Idioms to Press mappings. An Idiom may appear in multiple Press objects and removing the last reference to an Idiom is the equivalent of deleting it. Each Press may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Idiom to another Press is not a copy operation (eg: does not change its Id ).

Method Summary

Modifier and Type	Method	Description
void	assignIdiomToPress(Id idiomId, Id pressId)	Adds an existing Idiom to a Press .
boolean	canAssignIdioms()	Tests if this user can alter idiom/press mappings.
boolean	canAssignIdiomsToPress(Id pressId)	Tests if this user can alter idiom/press mappings.
IdList	getAssignablePressIds(Id pressId)	Gets a list of presses including and under the given press node in which any idiom can be assigned.
IdList	getAssignablePressIdsForIdiom(Id pressId, Id idiomId)	Gets a list of presses including and under the given press node in which a specific idiom can be assigned.
void	reassignIdiomToPress(Id idiomId, Id fromPressId, Id toPressId)	Moves an Idiom from one Press to another.
void	unassignIdiomFromPress(Id idiomId, Id pressId)	Removes an Idiom from a Press .

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

canAssignIdioms

boolean canAssignIdioms()

Tests if this user can alter idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if idiom assignment is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignIdiomsToPress

boolean canAssignIdiomsToPress(Id pressId)

Tests if this user can alter idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

pressId - the Id of the Press

Returns:

false if idiom assignment is not authorized, true otherwise

Throws:

NullArgumentException - pressId is null

Compliance:

mandatory - This method must be implemented.

getAssignablePressIds

IdList getAssignablePressIds(Id pressId)
                      throws OperationFailedException

Gets a list of presses including and under the given press node in which any idiom can be assigned.

Parameters:

pressId - the Id of the Press

Returns:

list of assignable press Ids

Throws:

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignablePressIdsForIdiom

IdList getAssignablePressIdsForIdiom(Id pressId,
 Id idiomId)
                              throws OperationFailedException

Gets a list of presses including and under the given press node in which a specific idiom can be assigned.

Parameters:

pressId - the Id of the Press

idiomId - the Id of the Idiom

Returns:

list of assignable press Ids

Throws:

NullArgumentException - pressId or idiomId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignIdiomToPress

void assignIdiomToPress(Id idiomId,
 Id pressId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Idiom to a Press .

Parameters:

idiomId - the Id of the Idiom

pressId - the Id of the Press

Throws:

AlreadyExistsException - idiomId is already assigned to pressId

NotFoundException - idiomId or pressId not found

NullArgumentException - idiomId or pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIdiomFromPress

void unassignIdiomFromPress(Id idiomId,
 Id pressId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Idiom from a Press .

Parameters:

idiomId - the Id of the Idiom

pressId - the Id of the Press

Throws:

NotFoundException - idiomId or pressId not found or idiomId not assigned to pressId

NullArgumentException - idiomId or pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignIdiomToPress

void reassignIdiomToPress(Id idiomId,
 Id fromPressId,
 Id toPressId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Idiom from one Press to another. Mappings to other Presses are unaffected.

Parameters:

idiomId - the Id of the Idiom

fromPressId - the Id of the current Press

toPressId - the Id of the destination Press

Throws:

NotFoundException - idiomId, fromPressId , or toPressId not found or idiomId not mapped to fromPressId

NullArgumentException - idiomId, fromPressId , or toPressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.