org.osid.voting

Interface PollsHierarchySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PollsHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Polls objects. Each node in the hierarchy is a unique Polls. The hierarchy may be traversed recursively to establish the tree structure through getParentPolls() and getChildPolls(). To relate these Ids to another OSID, getPollsNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Polls available in the Candidate 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 getParentPolls() or getChildPolls() 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: polls elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAccessPollsHierarchy() Tests if this user can perform hierarchy queries.
PollsList	getChildPolls(Id pollsId) Gets the children of the given polls.
IdList	getChildPollsIds(Id pollsId) Gets the child Ids of the given polls .
PollsList	getParentPolls(Id pollsId) Gets the parents of the given polls.
IdList	getParentPollsIds(Id pollsId) Gets the parent Ids of the given polls.
Hierarchy	getPollsHierarchy() Gets the hierarchy associated with this session.
Id	getPollsHierarchyId() Gets the hierarchy Id associated with this session.
Node	getPollsNodeIds(Id pollsId, long ancestorLevels, long descendantLevels, boolean includeSiblings) Gets a portion of the hierarchy for the given polls.
PollsNode	getPollsNodes(Id pollsId, long ancestorLevels, long descendantLevels, boolean includeSiblings) Gets a portion of the hierarchy for the given polls.
PollsList	getRootPolls() Gets the root polls in the polls hierarchy.
IdList	getRootPollsIds() Gets the root polls Ids in this hierarchy.
boolean	hasChildPolls(Id pollsId) Tests if a polls has any children.
boolean	hasParentPolls(Id pollsId) Tests if the Polls has any parents.
boolean	isAncestorOfPolls(Id id, Id pollsId) Tests if an Id is an ancestor of a polls.
boolean	isChildOfPolls(Id id, Id pollsId) Tests if a polls is a direct child of another.
boolean	isDescendantOfPolls(Id id, Id pollsId) Tests if an Id is a descendant of a polls.
boolean	isParentOfPolls(Id id, Id pollsId) Tests if an Id is a direct parent of a polls.
void	useComparativePollsView() The returns from the polls methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryPollsView() A complete view of the Polls returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPollsHierarchyId

Id getPollsHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPollsHierarchy

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

canAccessPollsHierarchy

boolean canAccessPollsHierarchy()

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 an application that may not offer traversal functions to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePollsView

void useComparativePollsView()

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

usePlenaryPollsView

void usePlenaryPollsView()

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

getRootPollsIds

IdList getRootPollsIds()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the root polls Ids in this hierarchy.

Returns:

the root polls Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootPolls

PollsList getRootPolls()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the root polls in the polls hierarchy. A node with no parents is an orphan. While all polls 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 polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentPolls

boolean hasParentPolls(Id pollsId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Tests if the Polls has any parents.

Parameters:

pollsId - the Id of a polls

Returns:

true if the polls has parents, false otherwise

Throws:

NotFoundException - pollsId is not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfPolls

boolean isParentOfPolls(Id id,
                      Id pollsId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Tests if an Id is a direct parent of a polls.

Parameters:

id - an Id

pollsId - the Id of a polls

Returns:

true if this id is a parent of pollsId, false otherwise

Throws:

NotFoundException - pollsId is not found

NullArgumentException - id or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - id not found return false.

getParentPollsIds

IdList getParentPollsIds(Id pollsId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the parent Ids of the given polls.

Parameters:

pollsId - the Id of a polls

Returns:

the parent Ids of the polls

Throws:

NotFoundException - pollsId is not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentPolls

PollsList getParentPolls(Id pollsId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the parents of the given polls.

Parameters:

pollsId - the Id to query

Returns:

the parents of the polls

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfPolls

boolean isAncestorOfPolls(Id id,
                        Id pollsId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Tests if an Id is an ancestor of a polls.

Parameters:

id - an Id

pollsId - the Id of a polls

Returns:

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

Throws:

NotFoundException - pollsId is not found

NullArgumentException - id or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - id not found return false.

hasChildPolls

boolean hasChildPolls(Id pollsId)
                      throws NotFoundException,
                             OperationFailedException,
                             PermissionDeniedException

Tests if a polls has any children.

Parameters:

pollsId - the Id of a polls

Returns:

true if the pollsId has children, false otherwise

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfPolls

boolean isChildOfPolls(Id id,
                     Id pollsId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Tests if a polls is a direct child of another.

Parameters:

id - an Id

pollsId - the Id of a polls

Returns:

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

Throws:

NotFoundException - pollsId is not found

NullArgumentException - id or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - id not found return false.

getChildPollsIds

IdList getChildPollsIds(Id pollsId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Gets the child Ids of the given polls .

Parameters:

pollsId - the Id to query

Returns:

the children of the polls

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildPolls

PollsList getChildPolls(Id pollsId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Gets the children of the given polls.

Parameters:

pollsId - the Id to query

Returns:

the children of the polls

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfPolls

boolean isDescendantOfPolls(Id id,
                          Id pollsId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Tests if an Id is a descendant of a polls.

Parameters:

id - an Id

pollsId - the Id of a polls

Returns:

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

Throws:

NotFoundException - pollsId is not found

NullArgumentException - id or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - id is not found return false.

getPollsNodeIds

Node getPollsNodeIds(Id pollsId,
                   long ancestorLevels,
                   long descendantLevels,
                   boolean includeSiblings)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets a portion of the hierarchy for the given polls.

Parameters:

pollsId - 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 polls node

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsNodes

PollsNode getPollsNodes(Id pollsId,
                      long ancestorLevels,
                      long descendantLevels,
                      boolean includeSiblings)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Gets a portion of the hierarchy for the given polls.

Parameters:

pollsId - 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 polls node

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.