Interface | osid.voting.rules.BallotConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes ballot constrainer
enablers. The data for create and update is provided via the
| ||
Method | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the polls | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBallotConstrainerEnabler | ||
Description |
Tests if this user can create ballot constrainer
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if BallotConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBallotConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | ballotConstrainerEnablerRecordTypes | array of ballot constrainer enabler record types |
Return | boolean | true if BallotConstrainerEnabler creation
using the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | ballotConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerEnablerFormForCreate | ||
Description |
Gets the ballot constrainer enabler form for creating new ballot constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | ballotConstrainerEnablerRecordTypes | array of ballot constrainer enabler record types |
Return | osid.voting.rules.BallotConstrainerEnablerForm | the ballot constrainer enabler form | |
Errors | NULL_ARGUMENT | ballotConstrainerEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBallotConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.voting.rules.BallotConstrainerEnablerForm | ballotConstrainerEnablerForm | the form for this BallotConstrainerEnabler |
Return | osid.voting.rules.BallotConstrainerEnabler | the new BallotConstrainerEnabler | |
Errors | ILLEGAL_STATE | ballotConstrainerEnablerForm already used for a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | ballotConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ballotConstrainerEnablerForm did not originate from
getBallotConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBallotConstrainerEnablers | ||
Description |
Tests if this user can update ballot constrainer
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if BallotConstrainerEnabler
modification is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerEnablerFormForUpdate | ||
Description |
Gets the ballot constrainer enabler form for updating a existing ballot constrainer enabler. A new ballot constrainer enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of the BallotConstrainerEnabler |
Return | osid.voting.rules.BallotConstrainerEnablerForm | the ballot constrainer enabler form | |
Errors | NOT_FOUND | ballotConstrainerEnablerId is not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBallotConstrainerEnabler | ||
Description |
Updates an existing ballot constrainer enabler. | ||
Parameters | osid.voting.rules.BallotConstrainerEnablerForm | ballotConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | ballotConstrainerEnablerForm already used for an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | ballotConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ballotConstrainerEnablerForm did not originate from
getBallotConstrainerEnablerFormFoUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBallotConstrainerEnablers | ||
Description |
Tests if this user can delete ballot constrainer
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if BallotConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBallotConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of the BallotConstrainerEnabler to
remove |
Errors | NOT_FOUND | ballotConstrainerEnablerId not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBallotConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if BallotConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBallotConstrainerEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of a BallotConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | ballotConstrainerEnablerId not found | ||
NULL_ARGUMENT | ballotConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |