OSID - osid.voting.CandidatePollsAssignmentSession Service Interface Definition

Interface	osid.voting.CandidatePollsAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods to re-assign `Candidates` to `Polls` . A `Candidate` may map to multiple `Polls` objects and removing the last reference to a `Candidate` is the equivalent of deleting it. Each `Polls` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of a `Candidate` to another `Polls` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignCandidates
Description	Tests if this user can alter candidate/polls mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCandidatesToPolls
Description	Tests if this user can alter candidate/polls mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`pollsId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignablePollsIds
Description	Gets a list of polls including and under the given polls node in which any candidate can be assigned.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Return	`osid.id.IdList`		list of assignable polls `Ids`
Errors	NULL_ARGUMENT		`pollsId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignablePollsIdsForCandidate
Description	Gets a list of polls including and under the given polls node in which a specific candidate can be assigned.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate`
Return	`osid.id.IdList`		list of assignable polls `Ids`
Errors	NULL_ARGUMENT		`pollsId` or `candidateId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCandidateToPolls
Description	Adds an existing `Candidate` to a `Polls` .
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate`
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Errors	ALREADY_EXISTS		`candidateId` is already assigned to `pollsId`
	NOT_FOUND		`candidateId` or `pollsId` not found
	NULL_ARGUMENT		`candidateId` or `pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCandidateFromPolls
Description	Removes a `Candidate` from a `Polls` .
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate`
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Errors	NOT_FOUND		`candidateId` or `pollsId` not found or `candidateId` not assigned to `pollsId`
	NULL_ARGUMENT		`candidateId` or `pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCandidateToPolls
Description	Moves a `Candidate` from one `Polls` to another. Mappings to other `Polls` are unaffected.
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate`
	`osid.id.Id`	`fromPollsId`	the `Id` of the current `Polls`
	`osid.id.Id`	`toPollsId`	the `Id` of the destination `Polls`
Errors	ALREADY_EXISTS		`candidateId` already assigned to `toPollsId`
	NOT_FOUND		`candidateId, fromPollsId` , or `toPollsId` not found or `candidateId` not mapped to `fromPollsId`
	NULL_ARGUMENT		`candidateId, fromPollsId` , or `toPollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.