Interface PressHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PressHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Presses . Each node in the hierarchy is a unique Press .

Method Summary

Modifier and Type	Method	Description
void	addChildPress(Id pressId, Id childId)	Adds a child to an press.
void	addRootPress(Id pressId)	Adds a root press.
boolean	canModifyPressHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getPressHierarchy()	Gets the hierarchy associated with this session.
Id	getPressHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildPress(Id pressId, Id childId)	Removes a child from an press.
void	removeChildPresses(Id pressId)	Removes all children from an press.
void	removeRootPress(Id pressId)	Removes a root 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

getPressHierarchyId

Id getPressHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPressHierarchy

Hierarchy getPressHierarchy()
                     throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyPressHierarchy

boolean canModifyPressHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an press that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootPress

void addRootPress(Id pressId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root press.

Parameters:

pressId - the Id of an press

Throws:

AlreadyExistsException - pressId is already in hierarchy

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootPress

void removeRootPress(Id pressId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root press.

Parameters:

pressId - the Id of an press

Throws:

NotFoundException - pressId is not a root

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildPress

void addChildPress(Id pressId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an press.

Parameters:

pressId - the Id of an press

childId - the Id of the new child

Throws:

AlreadyExistsException - pressId is already a parent of childId

NotFoundException - pressId or childId not found

NullArgumentException - pressId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPress

void removeChildPress(Id pressId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an press.

Parameters:

pressId - the Id of an press

childId - the Id of the new child

Throws:

NotFoundException - pressId is not parent of childId

NullArgumentException - pressId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPresses

void removeChildPresses(Id pressId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an press.

Parameters:

pressId - the Id of an press

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.