Interface PublisherHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PublisherHierarchySession
extends OsidSession

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

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 getParentPublishers() or getChildPublishers() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessPublisherHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildPublisherIds(Id publisherId)	Gets the child Ids of the given publisher.
PublisherList	getChildPublishers(Id publisherId)	Gets the child publishers of the given id .
IdList	getParentPublisherIds(Id publisherId)	Gets the parent Ids of the given publisher.
PublisherList	getParentPublishers(Id publisherId)	Gets the parent publishers of the given id .
Hierarchy	getPublisherHierarchy()	Gets the hierarchy associated with this session.
Id	getPublisherHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getPublisherNodeIds(Id publisherId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given publisher.
PublisherNode	getPublisherNodes(Id publisherId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given publisher.
IdList	getRootPublisherIds()	Gets the root publisher Ids in this hierarchy.
PublisherList	getRootPublishers()	Gets the root publishers in the publisher hierarchy.
boolean	hasChildPublishers(Id publisherId)	Tests if a publisher has any children.
boolean	hasParentPublishers(Id publisherId)	Tests if the Publisher has any parents.
boolean	isAncestorOfPublisher(Id id, Id publisherId)	Tests if an Id is an ancestor of a publisher.
boolean	isChildOfPublisher(Id id, Id publisherId)	Tests if a publisher is a direct child of another.
boolean	isDescendantOfPublisher(Id id, Id publisherId)	Tests if an Id is a descendant of a publisher.
boolean	isParentOfPublisher(Id id, Id publisherId)	Tests if an Id is a direct parent of publisher.
void	useComparativePublisherView()	The returns from the publisher methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryPublisherView()	A complete view of the Publisher 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

getPublisherHierarchyId

Id getPublisherHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPublisherHierarchy

Hierarchy getPublisherHierarchy()
                         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.

canAccessPublisherHierarchy

boolean canAccessPublisherHierarchy()

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 application 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.

useComparativePublisherView

void useComparativePublisherView()

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

usePlenaryPublisherView

void usePlenaryPublisherView()

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

getRootPublisherIds

IdList getRootPublisherIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root publisher Ids in this hierarchy.

Returns:

the root publisher Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootPublishers

PublisherList getRootPublishers()
                         throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root publishers

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentPublishers

boolean hasParentPublishers(Id publisherId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Publisher has any parents.

Parameters:

publisherId - a publisher Id

Returns:

true if the publisher has parents, f alse otherwise

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfPublisher

boolean isParentOfPublisher(Id id,
 Id publisherId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of publisher.

Parameters:

id - an Id

publisherId - the Id of a publisher

Returns:

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

Throws:

NotFoundException - publisherId is not found

NullArgumentException - id or publisherId 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} .

getParentPublisherIds

IdList getParentPublisherIds(Id publisherId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given publisher.

Parameters:

publisherId - a publisher Id

Returns:

the parent Ids of the publisher

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentPublishers

PublisherList getParentPublishers(Id publisherId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent publishers of the given id .

Parameters:

publisherId - the Id of the Publisher to query

Returns:

the parent publishers of the id

Throws:

NotFoundException - a Publisher identified by Id is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfPublisher

boolean isAncestorOfPublisher(Id id,
 Id publisherId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a publisher.

Parameters:

id - an Id

publisherId - the Id of a publisher

Returns:

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

Throws:

NotFoundException - publisherId is not found

NullArgumentException - id or publisherId 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} .

hasChildPublishers

boolean hasChildPublishers(Id publisherId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a publisher has any children.

Parameters:

publisherId - a publisher Id

Returns:

true if the publisherId has children, false otherwise

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfPublisher

boolean isChildOfPublisher(Id id,
 Id publisherId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a publisher is a direct child of another.

Parameters:

id - an Id

publisherId - the Id of a publisher

Returns:

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

Throws:

NotFoundException - publisherId is not found

NullArgumentException - id or publisherId 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} .

getChildPublisherIds

IdList getChildPublisherIds(Id publisherId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given publisher.

Parameters:

publisherId - the Id to query

Returns:

the children of the publisher

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildPublishers

PublisherList getChildPublishers(Id publisherId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child publishers of the given id .

Parameters:

publisherId - the Id of the Publisher to query

Returns:

the child publishers of the id

Throws:

NotFoundException - a Publisher identified by Id is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfPublisher

boolean isDescendantOfPublisher(Id id,
 Id publisherId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a publisher.

Parameters:

id - an Id

publisherId - the Id of a publisher

Returns:

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

Throws:

NotFoundException - publisherId is not found

NullArgumentException - id or publisherId 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} .

getPublisherNodeIds

Node getPublisherNodeIds(Id publisherId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given publisher.

Parameters:

publisherId - the Id to query

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

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

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

Returns:

a publisher node

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublisherNodes

PublisherNode getPublisherNodes(Id publisherId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given publisher.

Parameters:

publisherId - the Id to query

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

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

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

Returns:

a publisher node

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.