Interface | osid.voting.rules.RaceProcessorEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes race processor 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 | canCreateRaceProcessorEnabler | ||
Description |
Tests if this user can create race processor 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 RaceProcessorEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRaceProcessorEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | raceProcessorEnablerRecordTypes | array of race processor enabler record types |
Return | boolean | true if RaceProcessorEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | raceProcessorEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorEnablerFormForCreate | ||
Description |
Gets the race processor enabler form for creating new race processor enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | raceProcessorEnablerRecordTypes | array of race processor enabler record types |
Return | osid.voting.rules.RaceProcessorEnablerForm | the race processor enabler form | |
Errors | NULL_ARGUMENT | raceProcessorEnablerRecordTypes 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 | createRaceProcessorEnabler | ||
Description |
Creates a new | ||
Parameters | osid.voting.rules.RaceProcessorEnablerForm | raceProcessorEnablerForm | the form for this RaceProcessorEnabler |
Return | osid.voting.rules.RaceProcessorEnabler | the new RaceProcessorEnabler | |
Errors | ILLEGAL_STATE | raceProcessorEnablerForm already used for a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | raceProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceProcessorEnablerForm did not originate from
getRaceProcessorrEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRaceProcessorEnablers | ||
Description |
Tests if this user can update race processor 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 RaceProcessorEnabler modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorEnablerFormForUpdate | ||
Description |
Gets the race processor enabler form for updating an existing race processor enabler. A new race processor enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | raceProcessorEnablerId | the Id of the RaceProcessorEnabler |
Return | osid.voting.rules.RaceProcessorEnablerForm | the race processor enabler form | |
Errors | NOT_FOUND | raceProcessorEnablerId is not found | |
NULL_ARGUMENT | raceProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRaceProcessorEnabler | ||
Description |
Updates an existing race processor enabler. | ||
Parameters | osid.voting.rules.RaceProcessorEnablerForm | raceProcessorEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | raceProcessorEnablerForm already used for an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | raceProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceProcessorEnablerForm did not originate from
getRaceProcessorrEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRaceProcessorEnablers | ||
Description |
Tests if this user can delete race processor 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 RaceProcessorEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRaceProcessorEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | raceProcessorEnablerId | the Id of the RaceProcessorEnabler to remove |
Errors | NOT_FOUND | raceProcessorEnablerId not found | |
NULL_ARGUMENT | raceProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRaceProcessorEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if RaceProcessorEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRaceProcessorEnabler | ||
Description |
Adds a | ||
Parameters | osid.id.Id | raceProcessorEnablerId | the Id of a RaceProcessorEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | raceProcessorEnablerId not found | ||
NULL_ARGUMENT | raceProcessorEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |