Interface RaceConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply RaceConstrainerEnablers to RaceConstrainers . a RaceConstrainer with multiple RaceConstrainerEnablers means any positive rule evaluation across the enablers result in an effective RaceConstrainer .

Method Summary

Modifier and Type	Method	Description
void	assignRaceConstrainerEnablerToRaceConstrainer(Id raceConstrainerEnablerId, Id raceConstrainerId)	Adds an existing RaceConstrainerEnabler to a RaceConstrainer .
boolean	canAssignRaceConstrainerEnablers()	Tests if this user can alter race constrainer enabler/race constrainer mappings.
boolean	canSequenceRaceConstrainerEnablers()	Tests if this user can order RaceConstrainerEnablers .
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
void	moveRaceConstrainerEnablerAhead(Id raceConstrainerEnablerId, Id raceConstrainerId, Id referenceId)	Reorders race constrainer enablers for a race constrainer by moving the specified race constrainer enabler in front of a reference race constrainer enabler.
void	moveRaceConstrainerEnablerBehind(Id raceConstrainerEnablerId, Id raceConstrainerId, Id referenceId)	Reorders race constrainer enablers for a race constrainer by moving the specified race constrainer enabler behind a reference race constrainer enabler.
void	orderRaceConstrainerEnablers(Id[] raceConstrainerEnablerIds, Id raceConstrainerId)	Reorders a set of race constrainer enablers for a race constrainer.
void	unassignRaceConstrainerEnablerFromRaceConstrainer(Id raceConstrainerEnablerId, Id raceConstrainerId)	Removes a RaceConstrainerEnabler from a RaceConstrainer .

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.

canAssignRaceConstrainerEnablers

boolean canAssignRaceConstrainerEnablers()

Tests if this user can alter race constrainer enabler/race constrainer 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.

assignRaceConstrainerEnablerToRaceConstrainer

void assignRaceConstrainerEnablerToRaceConstrainer(Id raceConstrainerEnablerId,
 Id raceConstrainerId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing RaceConstrainerEnabler to a RaceConstrainer .

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

raceConstrainerId - the Id of the RaceConstrainer

Throws:

AlreadyExistsException - raceConstrainerEnablerId is already applied to raceConstrainerId

NotFoundException - raceConstrainerEnablerId or raceConstrainerId not found

NullArgumentException - raceConstrainerEnablerId or raceConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceConstrainerEnablerFromRaceConstrainer

void unassignRaceConstrainerEnablerFromRaceConstrainer(Id raceConstrainerEnablerId,
 Id raceConstrainerId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a RaceConstrainerEnabler from a RaceConstrainer .

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

raceConstrainerId - the Id of the RaceConstrainer

Throws:

NotFoundException - raceConstrainerEnablerId or raceConstrainerId not found or raceConstrainerEnablerId not applied to raceConstrainerId

NullArgumentException - raceConstrainerEnablerId or raceConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRaceConstrainerEnablers

boolean canSequenceRaceConstrainerEnablers()

Tests if this user can order RaceConstrainerEnablers . 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 RaceConstrainerEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveRaceConstrainerEnablerAhead

void moveRaceConstrainerEnablerAhead(Id raceConstrainerEnablerId,
 Id raceConstrainerId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerEnablerId - the Id of a RaceConstrainerEnabler

raceConstrainerId - the Id of a RaceConstrainer

referenceId - the reference race constrainer enabler Id

Throws:

NotFoundException - raceConstrainerEnablerId, raceConstrainerId , or referenceId not found or, raceConstrainerEnablerId or referenceId not related to raceConstrainerId

NullArgumentException - raceConstrainerEnablerId, raceConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRaceConstrainerEnablerBehind

void moveRaceConstrainerEnablerBehind(Id raceConstrainerEnablerId,
 Id raceConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerEnablerId - the Id of a RaceConstrainerEnabler

raceConstrainerId - the Id of a RaceConstrainer

referenceId - the reference race constrainer enabler Id

Throws:

NotFoundException - raceConstrainerEnablerId, raceConstrainerId , or referenceId not found or, raceConstrainerEnablerId or referenceId not related to raceConstrainerId

NullArgumentException - raceConstrainerEnablerId, raceConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRaceConstrainerEnablers

void orderRaceConstrainerEnablers(Id[] raceConstrainerEnablerIds,
 Id raceConstrainerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerEnablerIds - the Ids for a set of RaceConstrainerEnablers

raceConstrainerId - the Id of a RaceConstrainer

Throws:

NotFoundException - raceConstrainerId not found or, a raceConstrainerEnablerId not related to raceConstrainerId

NullArgumentException - raceConstrainerEnablerIds or raceConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.