OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceConstrainerEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes race constrainer enablers. The data for create and update is provided via the RaceConstrainerEnablerForm.

MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe polls
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateRaceConstrainerEnabler
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 RaceConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if RaceConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateRaceConstrainerEnablerWithRecordTypes
Description

Tests if this user can create a single RaceConstrainerEnabler using the desired record types. While VotingRulesManager.getRaceConstrainerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific RaceConstrainerEnabler. Providing an empty array tests if a RaceConstrainerEnabler can be created with no records.

Parametersosid.type.Type[]raceConstrainerEnablerRecordTypesarray of race constrainer enabler record types
Returnboolean true if RaceConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT raceConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerFormForCreate
Description

Gets the race constrainer enabler form for creating new race constrainer enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]raceConstrainerEnablerRecordTypesarray of race constrainer enabler record types
Returnosid.voting.rules.RaceConstrainerEnablerFormthe race constrainer enabler form
ErrorsNULL_ARGUMENT raceConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateRaceConstrainerEnabler
Description

Creates a new RaceConstrainerEnabler.

Parametersosid.voting.rules.RaceConstrainerEnablerFormraceConstrainerEnablerFormthe form for this RaceConstrainerEnabler
Returnosid.voting.rules.RaceConstrainerEnablerthe new RaceConstrainerEnabler
ErrorsILLEGAL_STATE raceConstrainerEnablerForm already used for a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT raceConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceConstrainerEnablerForm did not originate from getRaceConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateRaceConstrainerEnablers
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 RaceConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if RaceConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerFormForUpdate
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.

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
Returnosid.voting.rules.RaceConstrainerEnablerFormthe race constrainer enabler form
ErrorsNOT_FOUND raceConstrainerEnablerId is not found
NULL_ARGUMENT raceConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRaceConstrainerEnabler
Description

Updates an existing race constrainer enabler.

Parametersosid.voting.rules.RaceConstrainerEnablerFormraceConstrainerEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE raceConstrainerEnablerForm already used for an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT raceConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceConstrainerEnablerForm did not originate from getRaceConstrainerEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteRaceConstrainerEnablers
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 RaceConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if RaceConstrainerEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteRaceConstrainerEnabler
Description

Deletes a RaceConstrainerEnabler.

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler to remove
ErrorsNOT_FOUND raceConstrainerEnablerId not found
NULL_ARGUMENT raceConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageRaceConstrainerEnablerAliases
Description

Tests if this user can manage Id aliases for race constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if RaceConstrainerEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasRaceConstrainerEnabler
Description

Adds a Id to a RaceConstrainerEnabler for the purpose of creating compatibility. The primary Id of the RaceConstrainerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another race constrainer enabler. it is reassigned to the given race constrainer enabler Id.

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of a RaceConstrainerEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND raceConstrainerEnablerId not found
NULL_ARGUMENT raceConstrainerEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.