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

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

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.
MethodcanCreateRaceProcessorEnabler
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 RaceProcessorEnabler 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 RaceProcessorEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateRaceProcessorEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]raceProcessorEnablerRecordTypesarray of race processor enabler record types
Returnboolean true if RaceProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT raceProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorEnablerFormForCreate
Description

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

Parametersosid.type.Type[]raceProcessorEnablerRecordTypesarray of race processor enabler record types
Returnosid.voting.rules.RaceProcessorEnablerFormthe race processor enabler form
ErrorsNULL_ARGUMENT raceProcessorEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateRaceProcessorEnabler
Description

Creates a new RaceProcessorEnabler.

Parametersosid.voting.rules.RaceProcessorEnablerFormraceProcessorEnablerFormthe form for this RaceProcessorEnabler
Returnosid.voting.rules.RaceProcessorEnablerthe new RaceProcessorEnabler
ErrorsILLEGAL_STATE raceProcessorEnablerForm already used for a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT raceProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceProcessorEnablerForm did not originate from getRaceProcessorrEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateRaceProcessorEnablers
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 RaceProcessorEnabler 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 RaceProcessorEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorEnablerFormForUpdate
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.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
Returnosid.voting.rules.RaceProcessorEnablerFormthe race processor enabler form
ErrorsNOT_FOUND raceProcessorEnablerId is not found
NULL_ARGUMENT raceProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRaceProcessorEnabler
Description

Updates an existing race processor enabler.

Parametersosid.voting.rules.RaceProcessorEnablerFormraceProcessorEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE raceProcessorEnablerForm already used for an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT raceProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceProcessorEnablerForm did not originate from getRaceProcessorrEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteRaceProcessorEnablers
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 RaceProcessorEnabler 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 RaceProcessorEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteRaceProcessorEnabler
Description

Deletes a RaceProcessorEnabler.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler to remove
ErrorsNOT_FOUND raceProcessorEnablerId not found
NULL_ARGUMENT raceProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageRaceProcessorEnablerAliases
Description

Tests if this user can manage Id aliases for race processor 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 RaceProcessorEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasRaceProcessorEnabler
Description

Adds a Id to a RaceProcessorEnabler for the purpose of creating compatibility. The primary Id of the RaceProcessorEnabler 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 processor enabler. it is reassigned to the given race processor enabler Id.

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