Interface | osid.voting.rules.RaceConstrainerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes race constrainers. 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 | canCreateRaceConstrainer | ||
Description |
Tests if this user can create race constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if RaceConstrainer creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRaceConstrainerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | raceConstrainerRecordTypes | array of race constrainer record types |
Return | boolean | true if RaceConstrainer creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | raceConstrainerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceConstrainerFormForCreate | ||
Description |
Gets the race constrainer form for creating new race constrainers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | raceConstrainerRecordTypes | array of race constrainer record types |
Return | osid.voting.rules.RaceConstrainerForm | the race constrainer form | |
Errors | NULL_ARGUMENT | raceConstrainerRecordTypes 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 | createRaceConstrainer | ||
Description |
Creates a new | ||
Parameters | osid.voting.rules.RaceConstrainerForm | raceConstrainerForm | the form for this RaceConstrainer |
Return | osid.voting.rules.RaceConstrainer | the new RaceConstrainer | |
Errors | ILLEGAL_STATE | raceConstrainerForm already used for a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | raceConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceConstrainerForm did not originate from
getRaceConstrainerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRaceConstrainers | ||
Description |
Tests if this user can update race constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if RaceConstrainer modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceConstrainerFormForUpdate | ||
Description |
Gets the race constrainer form for updating an existing race constrainer. A new race constrainer form should be requested for each update transaction. | ||
Parameters | osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer |
Return | osid.voting.rules.RaceConstrainerForm | the race constrainer form | |
Errors | NOT_FOUND | raceConstrainerId is not found | |
NULL_ARGUMENT | raceConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRaceConstrainer | ||
Description |
Updates an existing race constrainer. | ||
Parameters | osid.voting.rules.RaceConstrainerForm | raceConstrainerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | raceConstrainerForm already used for an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | raceConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceConstrainerForm did not originate from
getRaceConstrainerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRaceConstrainers | ||
Description |
Tests if this user can delete race constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if RaceConstrainer deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRaceConstrainer | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer to remove |
Errors | NOT_FOUND | raceConstrainerId not found | |
NULL_ARGUMENT | raceConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRaceConstrainerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if RaceConstrainer aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRaceConstrainer | ||
Description |
Adds a | ||
Parameters | osid.id.Id | raceConstrainerId | the Id of a RaceConstrainer |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | raceConstrainerId not found | ||
NULL_ARGUMENT | raceConstrainerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |