Interface PollsHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PollsHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildPolls(Id pollsId, Id childId)	Adds a child to a polls.
void	addRootPolls(Id pollsId)	Adds a root polls.
boolean	canModifyPollsHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getPollsHierarchy()	Gets the hierarchy associated with this session.
Id	getPollsHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildPolls(Id pollsId)	Removes all children from a polls.
void	removeChildPolls(Id pollsId, Id childId)	Removes a child from a polls.
void	removeRootPolls(Id pollsId)	Removes a root polls.

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

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.

canModifyPollsHierarchy

boolean canModifyPollsHierarchy()

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

addRootPolls

void addRootPolls(Id pollsId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root polls.

Parameters:

pollsId - the Id of a polls

Throws:

AlreadyExistsException - pollsId is already in hierarchy

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootPolls

void removeRootPolls(Id pollsId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root polls.

Parameters:

pollsId - the Id of a polls

Throws:

NotFoundException - pollsId not a root

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildPolls

void addChildPolls(Id pollsId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a polls.

Parameters:

pollsId - the Id of a polls

childId - the Id of the new child

Throws:

AlreadyExistsException - pollsId is already a parent of childId

NotFoundException - pollsId or childId not found

NullArgumentException - pollsId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPolls

void removeChildPolls(Id pollsId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a polls.

Parameters:

pollsId - the Id of a polls

childId - the Id of the new child

Throws:

NotFoundException - pollsId not a parent of childId

NullArgumentException - pollsId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPolls

void removeChildPolls(Id pollsId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a polls.

Parameters:

pollsId - the Id of a polls

Throws:

NotFoundException - pollsId not in hierarchy

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.