Interface RaceConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply RaceConstrainers to Races . A Race with multiple RaceConstrainers means any positive rule evaluation across the constrainers result in an accessible Race .

Method Summary

Modifier and Type	Method	Description
void	assignRaceConstrainerToRace(Id raceConstrainerId, Id raceId)	Adds an existing RaceConstrainer to a Race .
boolean	canAssignRaceConstrainers()	Tests if this user can alter race constrainer/race mappings.
boolean	canSequenceRaceConstrainers()	Tests if this user can order RaceConstrainers .
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
void	moveRaceConstrainerAhead(Id raceConstrainerId, Id raceId, Id referenceId)	Reorders race constrainers for a race by moving the specified race constrainer in front of a reference race constrainer.
void	moveRaceConstrainerBehind(Id raceConstrainerId, Id raceId, Id referenceId)	Reorders race constrainers for a race by moving the specified race constrainer behind a reference race constrainer.
void	orderRaceConstrainers(Id[] raceConstrainerIds, Id raceId)	Reorders a set of race constrainers for a race.
void	unassignRaceConstrainerFromRace(Id raceConstrainerId, Id raceId)	Removes a RaceConstrainer from a Race .

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.

canAssignRaceConstrainers

boolean canAssignRaceConstrainers()

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

assignRaceConstrainerToRace

void assignRaceConstrainerToRace(Id raceConstrainerId,
 Id raceId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing RaceConstrainer to a Race .

Parameters:

raceConstrainerId - the Id of the RaceConstrainer

raceId - the Id of the Race

Throws:

AlreadyExistsException - raceConstrainerId is already applied to raceId

NotFoundException - raceConstrainerId or raceId not found

NullArgumentException - raceConstrainerId or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceConstrainerFromRace

void unassignRaceConstrainerFromRace(Id raceConstrainerId,
 Id raceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a RaceConstrainer from a Race .

Parameters:

raceConstrainerId - the Id of the RaceConstrainer

raceId - the Id of the Race

Throws:

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

NullArgumentException - raceConstrainerId or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRaceConstrainers

boolean canSequenceRaceConstrainers()

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

Compliance:

mandatory - This method must be implemented.

moveRaceConstrainerAhead

void moveRaceConstrainerAhead(Id raceConstrainerId,
 Id raceId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerId - the Id of a RaceConstrainer

raceId - the Id of a Race

referenceId - the reference race constrainer Id

Throws:

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

NullArgumentException - raceConstrainerId, raceId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRaceConstrainerBehind

void moveRaceConstrainerBehind(Id raceConstrainerId,
 Id raceId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerId - the Id of a RaceConstrainer

raceId - the Id of a Race

referenceId - the reference race constrainer Id

Throws:

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

NullArgumentException - raceConstrainerId, raceId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRaceConstrainers

void orderRaceConstrainers(Id[] raceConstrainerIds,
 Id raceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of race constrainers for a race.

Parameters:

raceConstrainerIds - the Ids for a set of RaceConstrainers

raceId - the Id of a Race

Throws:

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

NullArgumentException - raceConstrainerIds or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.