Interface | osid.voting.rules.RaceConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes race 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 | canCreateRaceConstrainerEnabler | ||
Description |
Tests if this user can create race 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 RaceConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRaceConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | raceConstrainerEnablerRecordTypes | array of race constrainer enabler record types |
Return | boolean | true if RaceConstrainerEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | raceConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceConstrainerEnablerFormForCreate | ||
Description |
Gets the race constrainer enabler form for creating new race constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | raceConstrainerEnablerRecordTypes | array of race constrainer enabler record types |
Return | osid.voting.rules.RaceConstrainerEnablerForm | the race constrainer enabler form | |
Errors | NULL_ARGUMENT | raceConstrainerEnablerRecordTypes 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 | createRaceConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.voting.rules.RaceConstrainerEnablerForm | raceConstrainerEnablerForm | the form for this RaceConstrainerEnabler |
Return | osid.voting.rules.RaceConstrainerEnabler | the new RaceConstrainerEnabler | |
Errors | ILLEGAL_STATE | raceConstrainerEnablerForm already used for a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | raceConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceConstrainerEnablerForm did not originate from
getRaceConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRaceConstrainerEnablers | ||
Description |
Tests if this user can update race 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 RaceConstrainerEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceConstrainerEnablerFormForUpdate | ||
Description |
Gets the race constrainer enabler form for updating an existing race constrainer enabler. A new race constrainer enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | raceConstrainerEnablerId | the Id of the RaceConstrainerEnabler |
Return | osid.voting.rules.RaceConstrainerEnablerForm | the race constrainer enabler form | |
Errors | NOT_FOUND | raceConstrainerEnablerId is not found | |
NULL_ARGUMENT | raceConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRaceConstrainerEnabler | ||
Description |
Updates an existing race constrainer enabler. | ||
Parameters | osid.voting.rules.RaceConstrainerEnablerForm | raceConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | raceConstrainerEnablerForm already used for an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | raceConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceConstrainerEnablerForm did not originate from
getRaceConstrainerEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRaceConstrainerEnablers | ||
Description |
Tests if this user can delete race 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 RaceConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRaceConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | raceConstrainerEnablerId | the Id of the RaceConstrainerEnabler to
remove |
Errors | NOT_FOUND | raceConstrainerEnablerId not found | |
NULL_ARGUMENT | raceConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRaceConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if RaceConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRaceConstrainerEnabler | ||
Description |
Adds a | ||
Parameters | osid.id.Id | raceConstrainerEnablerId | the Id of a RaceConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | raceConstrainerEnablerId not found | ||
NULL_ARGUMENT | raceConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |