Interface | osid.voting.BallotPollsAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
Method | canAssignBallots | ||
Description |
Tests if this user can alter ballot/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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignBallotsToPolls | ||
Description |
Tests if this user can alter ballot/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
| ||
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 ballot 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 | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignablePollsIdsForBallot | ||
Description |
Gets a list of polls including and under the given polls node in which a specific ballot can be assigned. | ||
Parameters | osid.id.Id | pollsId | the Id of the Polls |
osid.id.Id | ballotId | the Id of the Ballot | |
Return | osid.id.IdList | list of assignable polls Ids | |
Errors | NULL_ARGUMENT | pollsId or ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignBallotToPolls | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | ballotId | the Id of the Ballot |
osid.id.Id | pollsId | the Id of the Polls | |
Errors | ALREADY_EXISTS | ballotId is already assigned to pollsId | |
NOT_FOUND | ballotId or pollsId not found | ||
NULL_ARGUMENT | ballotId or pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBallotFromPolls | ||
Description |
Removes a | ||
Parameters | osid.id.Id | ballotId | the Id of the Ballot |
osid.id.Id | pollsId | the Id of the Polls | |
Errors | NOT_FOUND | ballotId or pollsId not found or
ballotId not assigned to pollsId | |
NULL_ARGUMENT | ballotId or pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |