Interface RaceProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply RaceProcessorEnablers to RaceProcessors . a RaceProcessor with multiple RaceProcessorEnablers means any positive rule evaluation across the enablers result in an effective RaceProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignRaceProcessorEnablerToRaceProcessor(Id raceProcessorEnablerId, Id raceProcessorId)	Adds an existing RaceProcessorEnabler to a RaceProcessor .
boolean	canAssignRaceProcessorEnablers()	Tests if this user can alter race processor enabler/race processor mappings.
boolean	canSequenceRaceProcessorEnablers()	Tests if this user can order RaceProcessorEnablers .
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
void	moveRaceProcessorEnablerAhead(Id raceProcessorEnablerId, Id raceProcessorId, Id referenceId)	Reorders race processor enablers for a race processor by moving the specified race processor enabler in front of a reference race processor enabler.
void	moveRaceProcessorEnablerBehind(Id raceProcessorEnablerId, Id raceProcessorId, Id referenceId)	Reorders race processor enablers for a race processor by moving the specified race processor enabler behind a reference race processor enabler.
void	orderRaceProcessorEnablers(Id[] raceProcessorEnablerIds, Id raceProcessorId)	Reorders a set of race processor enablers for a race processor.
void	unassignRaceProcessorEnablerFromRaceProcessor(Id raceProcessorEnablerId, Id raceProcessorId)	Removes a RaceProcessorEnabler from a RaceProcessor .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
        throws OperationFailedException,
PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignRaceProcessorEnablers

boolean canAssignRaceProcessorEnablers()

Tests if this user can alter race processor enabler/race processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignRaceProcessorEnablerToRaceProcessor

void assignRaceProcessorEnablerToRaceProcessor(Id raceProcessorEnablerId,
 Id raceProcessorId)
                                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing RaceProcessorEnabler to a RaceProcessor .

Parameters:

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

raceProcessorId - the Id of the RaceProcessor

Throws:

AlreadyExistsException - raceProcessorEnablerId is already applied to raceProcessorId

NotFoundException - raceProcessorEnablerId or raceProcessorId not found

NullArgumentException - raceProcessorEnablerId or raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceProcessorEnablerFromRaceProcessor

void unassignRaceProcessorEnablerFromRaceProcessor(Id raceProcessorEnablerId,
 Id raceProcessorId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a RaceProcessorEnabler from a RaceProcessor .

Parameters:

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

raceProcessorId - the Id of the RaceProcessor

Throws:

NotFoundException - raceProcessorEnablerId or raceProcessorId not found or raceProcessorEnablerId not applied to raceProcessorId

NullArgumentException - raceProcessorEnablerId or raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRaceProcessorEnablers

boolean canSequenceRaceProcessorEnablers()

Tests if this user can order RaceProcessorEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if RaceProcessorEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveRaceProcessorEnablerAhead

void moveRaceProcessorEnablerAhead(Id raceProcessorEnablerId,
 Id raceProcessorId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders race processor enablers for a race processor by moving the specified race processor enabler in front of a reference race processor enabler.

Parameters:

raceProcessorEnablerId - the Id of a RaceProcessorEnabler

raceProcessorId - the Id of a RaceProcessor

referenceId - the reference race processor enabler Id

Throws:

NotFoundException - raceProcessorEnablerId, raceProcessorId , or referenceId not found or, raceProcessorEnablerId or referenceId not related to processorId

NullArgumentException - raceProcessorEnablerId, raceProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRaceProcessorEnablerBehind

void moveRaceProcessorEnablerBehind(Id raceProcessorEnablerId,
 Id raceProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders race processor enablers for a race processor by moving the specified race processor enabler behind a reference race processor enabler.

Parameters:

raceProcessorEnablerId - the Id of a RaceProcessorEnabler

raceProcessorId - the Id of a RaceProcessor

referenceId - the reference race processor enabler Id

Throws:

NotFoundException - praceProcessorEnablerId, raceProcessorId , or referenceId not found or, raceProcessorEnablerId or referenceId not related to processorId

NullArgumentException - raceProcessorEnablerId, raceProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRaceProcessorEnablers

void orderRaceProcessorEnablers(Id[] raceProcessorEnablerIds,
 Id raceProcessorId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of race processor enablers for a race processor.

Parameters:

raceProcessorEnablerIds - the Ids for a set of RaceProcessorEnablers

raceProcessorId - the Id of a RaceProcessor

Throws:

NotFoundException - raceProcessorId not found or, a raceProcessorEnablerId not related to raceProcessorId

NullArgumentException - raceProcessorEnablerIds or raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.