Interface RaceConstrainerEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceConstrainerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving RaceConstrainerEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated polls view: All race constrainer enabler methods in this session operate, retrieve and pertain to race constrainer enablers defined explicitly in the current polls. Using an isolated view is useful for managing RaceConstrainerEnablers with the RaceConstrainerEnablerAdminSession .
• federated polls view: All race constrainer enabler methods in this session operate, retrieve and pertain to all race constrainer enablers defined in this polls and any other race constrainer enablers implicitly available in this polls through polls inheritence.
• active race constrainer enabler view: All race constrainer enabler lookup methods return active race constrainer enablers.
• any status race constrainer enabler view: Race constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedPollsView() and useIsolatedPollsView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupRaceConstrainerEnablers()	Tests if this user can perform RaceConstrainerEnablers lookups.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
RaceConstrainerEnabler	getRaceConstrainerEnabler(Id raceConstrainerEnablerId)	Gets the RaceConstrainerEnabler specified by its Id .
RaceConstrainerEnablerList	getRaceConstrainerEnablers()	Gets all RaceConstrainerEnablers .
RaceConstrainerEnablerList	getRaceConstrainerEnablersByGenusType(Type raceConstrainerEnablerGenusType)	Gets a RaceConstrainerEnablerList corresponding to the given race constrainer enabler genus Type which does not include race constrainer enablers of genus types derived from the specified Type .
RaceConstrainerEnablerList	getRaceConstrainerEnablersByIds(IdList raceConstrainerEnablerIds)	Gets a RaceConstrainerEnablerList corresponding to the given IdList .
RaceConstrainerEnablerList	getRaceConstrainerEnablersByParentGenusType(Type raceConstrainerEnablerGenusType)	Gets a RaceConstrainerEnablerList corresponding to the given race constrainer enabler genus Type and include any additional race constrainer enablers with genus types derived from the specified Type .
RaceConstrainerEnablerList	getRaceConstrainerEnablersByRecordType(Type raceConstrainerEnablerRecordType)	Gets a RaceConstrainerEnablerList containing the given race constrainer enabler record Type .
RaceConstrainerEnablerList	getRaceConstrainerEnablersOnDate(DateTime from, DateTime to)	Gets a RaceConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
RaceConstrainerEnablerList	getRaceConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a RaceConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveRaceConstrainerEnablerView()	Only active race constrainer enablers are returned by methods in this session.
void	useAnyStatusRaceConstrainerEnablerView()	All active and inactive race constrainer enablers are returned by methods in this session.
void	useComparativeRaceConstrainerEnablerView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedPollsView()	Federates the view for methods in this session.
void	useIsolatedPollsView()	Isolates the view for methods in this session.
void	usePlenaryRaceConstrainerEnablerView()	A complete view of the RaceConstrainerEnabler returns is desired.

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.

canLookupRaceConstrainerEnablers

boolean canLookupRaceConstrainerEnablers()

Tests if this user can perform RaceConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRaceConstrainerEnablerView

void useComparativeRaceConstrainerEnablerView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRaceConstrainerEnablerView

void usePlenaryRaceConstrainerEnablerView()

A complete view of the RaceConstrainerEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedPollsView

void useFederatedPollsView()

Federates the view for methods in this session. A federated view will include race constrainer enablers in polls which are children of this polls in the polls hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedPollsView

void useIsolatedPollsView()

Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.

Compliance:

mandatory - This method is must be implemented.

useActiveRaceConstrainerEnablerView

void useActiveRaceConstrainerEnablerView()

Only active race constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusRaceConstrainerEnablerView

void useAnyStatusRaceConstrainerEnablerView()

All active and inactive race constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getRaceConstrainerEnabler

RaceConstrainerEnabler getRaceConstrainerEnabler(Id raceConstrainerEnablerId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the RaceConstrainerEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned RaceConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a RaceConstrainerEnabler and retained for compatibility. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

raceConstrainerEnablerId - Id of the RaceConstrainerEnabler

Returns:

the race constrainer enabler

Throws:

NotFoundException - raceConstrainerEnablerId not found

NullArgumentException - raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceConstrainerEnablersByIds

RaceConstrainerEnablerList getRaceConstrainerEnablersByIds(IdList raceConstrainerEnablerIds)
                                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the race constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible RaceConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

raceConstrainerEnablerIds - the list of Ids to retrieve

Returns:

the returned RaceConstrainerEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - raceConstrainerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersByGenusType

RaceConstrainerEnablerList getRaceConstrainerEnablersByGenusType(Type raceConstrainerEnablerGenusType)
                                                          throws OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList corresponding to the given race constrainer enabler genus Type which does not include race constrainer enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

raceConstrainerEnablerGenusType - a race constrainer enabler genus type

Returns:

the returned RaceConstrainerEnabler list

Throws:

NullArgumentException - raceConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersByParentGenusType

RaceConstrainerEnablerList getRaceConstrainerEnablersByParentGenusType(Type raceConstrainerEnablerGenusType)
                                                                throws OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList corresponding to the given race constrainer enabler genus Type and include any additional race constrainer enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

raceConstrainerEnablerGenusType - a race constrainer enabler genus type

Returns:

the returned RaceConstrainerEnabler list

Throws:

NullArgumentException - raceConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersByRecordType

RaceConstrainerEnablerList getRaceConstrainerEnablersByRecordType(Type raceConstrainerEnablerRecordType)
                                                           throws OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList containing the given race constrainer enabler record Type . In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

raceConstrainerEnablerRecordType - a race constrainer enabler record type

Returns:

the returned RaceConstrainerEnabler list

Throws:

NullArgumentException - raceConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersOnDate

RaceConstrainerEnablerList getRaceConstrainerEnablersOnDate(DateTime from,
 DateTime to)
                                                     throws OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned RaceConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersOnDateWithAgent

RaceConstrainerEnablerList getRaceConstrainerEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                              throws OperationFailedException,
PermissionDeniedException

Gets a RaceConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned RaceConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablers

RaceConstrainerEnablerList getRaceConstrainerEnablers()
                                               throws OperationFailedException,
PermissionDeniedException

Gets all RaceConstrainerEnablers . In plenary mode, the returned list contains all known race constrainer enablers or an error results. Otherwise, the returned list may contain only those race constrainer enablers that are accessible through this session. In active mode, race constrainer enablers are returned that are currently active. In any status mode, active and inactive race constrainer enablers are returned.

Returns:

the returned RaceConstrainerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.