OSID - osid.voting.VoterAllocationAdminSession Service Interface Definition

Interface	osid.voting.VoterAllocationAdminSession
Implements	`osid.OsidSession`
Description	This session manages voter allocations. All voters are assumed to have a default allocation form such that this session only provides an update mechanism. The data for update is provided via the `VoterAllocationForm.`
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the polls
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageVoterAllocations
Description	Tests if this user can manage voter allocation. A return of true does not guarantee successful authorization. A return of false indicates that it is known allocation methods will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer allocation operations to an unauthorized user.
Return	`boolean`		`false` if voter allocation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVoterAllocationFormForUpdate
Description	Gets the voter allocation form. A new form should be requested for each update transaction.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Voter`
Return	`osid.voting.VoterAllocationForm`		the voter allocation form
Errors	NOT_FOUND		`raceId` or `resourceId` is not found
	NULL_ARGUMENT		`raceId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateVoterAllocation
Description	Updates an allocation for a voter.
Parameters	`osid.voting.VoterAllocationForm`	`voterAllocationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`voterAllocationForm` already used in a create transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`voterAllocationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voterAllocationForm` did not originate from `getVoterAllocationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.