OSID - osid.voting.PollsHierarchyDesignSession Service Interface Definition

Interface	osid.voting.PollsHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session defines methods for managing a hierarchy of `Polls` objects. Each node in the hierarchy is a unique `Polls` .
Method	getPollsHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPollsHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canModifyPollsHierarchy
Description	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.
Return	`boolean`		`false` if changing this hierarchy is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addRootPolls
Description	Adds a root polls.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a polls
Errors	ALREADY_EXISTS		`pollsId` is already in hierarchy
	NOT_FOUND		`pollsId` not found
	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootPolls
Description	Removes a root polls.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a polls
Errors	NOT_FOUND		`pollsId` not a root
	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildPolls
Description	Adds a child to a polls.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a polls
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`pollsId` is already a parent of `childId`
	NOT_FOUND		`pollsId` or `childId` not found
	NULL_ARGUMENT		`pollsId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildPolls
Description	Removes a child from a polls.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a polls
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`pollsId` not a parent of `childId`
	NULL_ARGUMENT		`pollsId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildPolls
Description	Removes all children from a polls.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a polls
Errors	NOT_FOUND		`pollsId` not in hierarchy
	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.