public interface RaceProcessorAdminSession extends OsidSession
This session creates and removes race processors. The data for create
and update is provided via the RaceProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasRaceProcessor(Id raceProcessorId,
Id aliasId)
Adds a
Id to a RaceProcessor for the
purpose of creating compatibility. |
boolean |
canCreateRaceProcessor()
Tests if this user can create race processors.
|
boolean |
canCreateRaceProcessorWithRecordTypes(Type[] raceProcessorRecordTypes)
Tests if this user can create a single
RaceProcessor
using the desired record types. |
boolean |
canDeleteRaceProcessors()
Tests if this user can delete race processors.
|
boolean |
canManageRaceProcessorAliases()
Tests if this user can manage
Id aliases for race
processors. |
boolean |
canUpdateRaceProcessors()
Tests if this user can update race processors.
|
RaceProcessor |
createRaceProcessor(RaceProcessorForm raceProcessorForm)
Creates a new
RaceProcessor. |
void |
deleteRaceProcessor(Id raceProcessorId)
Deletes a
RaceProcessor. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceProcessorForm |
getRaceProcessorFormForCreate(Type[] raceProcessorRecordTypes)
Gets the race processor form for creating new race processors.
|
RaceProcessorForm |
getRaceProcessorFormForUpdate(Id raceProcessorId)
Gets the race processor form for updating an existing race processor.
|
void |
updateRaceProcessor(RaceProcessorForm raceProcessorForm)
Updates an existing race processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateRaceProcessor()
RaceProcessor
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. false
if RaceProcessor
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateRaceProcessorWithRecordTypes(Type[] raceProcessorRecordTypes)
RaceProcessor
using the desired record types. While
VotingRulesManager.getRaceProcessorRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific RaceProcessor.
Providing an empty array tests if a RaceProcessor
can be created with no records.raceProcessorRecordTypes
- array of race processor types true
if RaceProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- raceProcessorRecordTypes
is null
mandatory
- This method must be implemented. RaceProcessorForm getRaceProcessorFormForCreate(Type[] raceProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
raceProcessorRecordTypes
- array of race processor typesNullArgumentException
- raceProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. RaceProcessor createRaceProcessor(RaceProcessorForm raceProcessorForm) throws OperationFailedException, PermissionDeniedException
RaceProcessor.
raceProcessorForm
- the form for this RaceProcessor
RaceProcessor
IllegalStateException
- raceProcessorForm
already used for a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- raceProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- raceProcessorForm did not
originate from getRaceProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateRaceProcessors()
RaceProcessor
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. false
if RaceProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. RaceProcessorForm getRaceProcessorFormForUpdate(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorId
- the Id
of the
RaceProcessor
NotFoundException
- raceProcessorId
is
not foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateRaceProcessor(RaceProcessorForm raceProcessorForm) throws OperationFailedException, PermissionDeniedException
raceProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- raceProcessorForm
already used for an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- raceProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- raceProcessorForm did not
originate from getRaceProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteRaceProcessors()
RaceProcessor
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. false
if RaceProcessor
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor.
raceProcessorId
- the Id
of the
RaceProcessor
to removeNotFoundException
- raceProcessorId
not
foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageRaceProcessorAliases()
Id
aliases for race
processors. 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. false
if RaceProcessor
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasRaceProcessor(Id raceProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a RaceProcessor
for the
purpose of creating compatibility. The primary Id
of
the RaceProcessor
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. it is
reassigned to the given race processor Id.
raceProcessorId
- the Id
of a
RaceProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- raceProcessorId
not
foundNullArgumentException
- raceProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.