Interface PressHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PressHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Presses . Each node in the hierarchy is a unique Press . The hierarchy may be traversed recursively to establish the tree structure through getParentPresses() and getChildPresses() . To relate these Ids to another OSID, getPressNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Press available in the Lexicon OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root press or a child of another press.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentPresses() or getChildPresses() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized textways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative press view: press elements may be silently omitted or re-ordered
• plenary press view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessPressHierarchy()	Tests if this user can perform hierarchy queries.
PressList	getChildPresses(Id pressId)	Gets the children of the given press.
IdList	getChildPressIds(Id pressId)	Gets the child Ids of the given press.
PressList	getParentPresses(Id pressId)	Gets the parents of the given press.
IdList	getParentPressIds(Id pressId)	Gets the parent Ids of the given press.
Hierarchy	getPressHierarchy()	Gets the hierarchy associated with this session.
Id	getPressHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getPressNodeIds(Id pressId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given press.
PressNode	getPressNodes(Id pressId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given press.
PressList	getRootPresses()	Gets the root press in the press hierarchy.
IdList	getRootPressIds()	Gets the root press Ids in this hierarchy.
boolean	hasChildPresses(Id pressId)	Tests if an press has any children.
boolean	hasParentPresses(Id pressId)	Tests if the Press has any parents.
boolean	isAncestorOfPress(Id id, Id pressId)	Tests if an Id is an ancestor of an press.
boolean	isChildOfPress(Id id, Id pressId)	Tests if an press is a direct child of another.
boolean	isDescendantOfPress(Id id, Id pressId)	Tests if an Id is a descendant of an press.
boolean	isParentOfPress(Id id, Id pressId)	Tests if an Id is a direct parent of press.
void	useComparativePressView()	The returns from the press methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryPressView()	A complete view of the Presses 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

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.

canAccessPressHierarchy

boolean canAccessPressHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePressView

void useComparativePressView()

The returns from the press 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.

usePlenaryPressView

void usePlenaryPressView()

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

getRootPressIds

IdList getRootPressIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root press Ids in this hierarchy.

Returns:

the root press Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootPresses

PressList getRootPresses()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root press in the press hierarchy. an press with no parents is an orphan. While all press Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root press or child of another press.

Returns:

the root presses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentPresses

boolean hasParentPresses(Id pressId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Press has any parents.

Parameters:

pressId - an press Id

Returns:

true if the press has parents, f alse otherwise

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.

isParentOfPress

boolean isParentOfPress(Id id,
 Id pressId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of press.

Parameters:

id - an Id

pressId - the Id of an press

Returns:

true if this id is a parent of pressId , f alse otherwise

Throws:

NotFoundException - pressId is not found

NullArgumentException - id or pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentPressIds

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

Gets the parent Ids of the given press.

Parameters:

pressId - an press Id

Returns:

the parent Ids of the 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.

getParentPresses

PressList getParentPresses(Id pressId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given press.

Parameters:

pressId - the Id to query

Returns:

the parents of the press

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfPress

boolean isAncestorOfPress(Id id,
 Id pressId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an press.

Parameters:

id - an Id

pressId - the Id of an press

Returns:

true if this id is an ancestor of pressId , false otherwise

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildPresses

boolean hasChildPresses(Id pressId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an press has any children.

Parameters:

pressId - an press Id

Returns:

true if the pressId has children, false otherwise

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfPress

boolean isChildOfPress(Id id,
 Id pressId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an press is a direct child of another.

Parameters:

id - an Id

pressId - the Id of an press

Returns:

true if the id is a child of pressId , false otherwise

Throws:

NotFoundException - pressId not found

NullArgumentException - id or pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildPressIds

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

Gets the child Ids of the given press.

Parameters:

pressId - the Id to query

Returns:

the children of the press

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildPresses

PressList getChildPresses(Id pressId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given press.

Parameters:

pressId - the Id to query

Returns:

the children of the press

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfPress

boolean isDescendantOfPress(Id id,
 Id pressId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an press.

Parameters:

id - an Id

pressId - the Id of an press

Returns:

true if the id is a descendant of the pressId , false otherwise

Throws:

NotFoundException - pressId not found

NullArgumentException - id or pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getPressNodeIds

Node getPressNodeIds(Id pressId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given press.

Parameters:

pressId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the press.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the press.

includeSiblings - true to include the siblings of the given press, false to omit the siblings

Returns:

an press node

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPressNodes

PressNode getPressNodes(Id pressId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given press.

Parameters:

pressId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the hierarchy.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the hierarchy.

includeSiblings - true to include the siblings of the given press, false to omit the siblings

Returns:

an press node

Throws:

NotFoundException - pressId not found

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.