Interface RaceProcessorEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceProcessorEnablerLookupSession
extends OsidSession

This session provides methods for retrieving RaceProcessorEnablers .

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 processor enabler methods in this session operate, retrieve and pertain to race processor enablers defined explicitly in the current polls. Using an isolated view is useful for managing RaceProcessorEnablers with the RaceProcessorEnablerAdminSession .
• federated polls view: All race processor enabler methods in this session operate, retrieve and pertain to all race processor enablers defined in this polls and any other race processor enablers implicitly available in this polls through polls inheritence.
• active race processor enabler view: All race processor enabler lookup methods return active race processor enablers.
• any status race processor enabler view: Race processor 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	canLookupRaceProcessorEnablers()	Tests if this user can perform RaceProcessorEnablers lookups.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
RaceProcessorEnabler	getRaceProcessorEnabler(Id raceProcessorEnablerId)	Gets the RaceProcessorEnabler specified by its Id .
RaceProcessorEnablerList	getRaceProcessorEnablers()	Gets all RaceProcessorEnablers .
RaceProcessorEnablerList	getRaceProcessorEnablersByGenusType(Type raceProcessorEnablerGenusType)	Gets a RaceProcessorEnablerList corresponding to the given race processor enabler genus Type which does not include race processor enablers of genus types derived from the specified Type .
RaceProcessorEnablerList	getRaceProcessorEnablersByIds(IdList raceProcessorEnablerIds)	Gets a RaceProcessorEnablerList corresponding to the given IdList .
RaceProcessorEnablerList	getRaceProcessorEnablersByParentGenusType(Type raceProcessorEnablerGenusType)	Gets a RaceProcessorEnablerList corresponding to the given race processor enabler genus Type and include any additional race processor enablers with genus types derived from the specified Type .
RaceProcessorEnablerList	getRaceProcessorEnablersByRecordType(Type raceProcessorEnablerRecordType)	Gets a RaceProcessorEnablerList containing the given race processor enabler record Type .
RaceProcessorEnablerList	getRaceProcessorEnablersOnDate(DateTime from, DateTime to)	Gets a RaceProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
RaceProcessorEnablerList	getRaceProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a RaceProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveRaceProcessorEnablerView()	Only active race processor enablers are returned by methods in this session.
void	useAnyStatusRaceProcessorEnablerView()	All active and inactive race processor enablers are returned by methods in this session.
void	useComparativeRaceProcessorEnablerView()	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	usePlenaryRaceProcessorEnablerView()	A complete view of the RaceProcessorEnabler 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.

canLookupRaceProcessorEnablers

boolean canLookupRaceProcessorEnablers()

Tests if this user can perform RaceProcessorEnablers 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.

useComparativeRaceProcessorEnablerView

void useComparativeRaceProcessorEnablerView()

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.

usePlenaryRaceProcessorEnablerView

void usePlenaryRaceProcessorEnablerView()

A complete view of the RaceProcessorEnabler 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 processor 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.

useActiveRaceProcessorEnablerView

void useActiveRaceProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusRaceProcessorEnablerView

void useAnyStatusRaceProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getRaceProcessorEnabler

RaceProcessorEnabler getRaceProcessorEnabler(Id raceProcessorEnablerId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorEnablerId - Id of the RaceProcessorEnabler

Returns:

the race processor enabler

Throws:

NotFoundException - raceProcessorEnablerId not found

NullArgumentException - raceProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceProcessorEnablersByIds

RaceProcessorEnablerList getRaceProcessorEnablersByIds(IdList raceProcessorEnablerIds)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a RaceProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the race processor 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 RaceProcessorEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.

Parameters:

raceProcessorEnablerIds - the list of Ids to retrieve

Returns:

the returned RaceProcessorEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - raceProcessorEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablersByGenusType

RaceProcessorEnablerList getRaceProcessorEnablersByGenusType(Type raceProcessorEnablerGenusType)
                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorEnablerGenusType - a race processor enabler genus type

Returns:

the returned RaceProcessorEnabler list

Throws:

NullArgumentException - raceProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablersByParentGenusType

RaceProcessorEnablerList getRaceProcessorEnablersByParentGenusType(Type raceProcessorEnablerGenusType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorEnablerGenusType - a race processor enabler genus type

Returns:

the returned RaceProcessorEnabler list

Throws:

NullArgumentException - raceProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablersByRecordType

RaceProcessorEnablerList getRaceProcessorEnablersByRecordType(Type raceProcessorEnablerRecordType)
                                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorEnablerRecordType - a race processor enabler record type

Returns:

the returned RaceProcessorEnabler list

Throws:

NullArgumentException - raceProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablersOnDate

RaceProcessorEnablerList getRaceProcessorEnablersOnDate(DateTime from,
 DateTime to)
                                                 throws OperationFailedException,
PermissionDeniedException

Gets a RaceProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned RaceProcessorEnabler 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.

getRaceProcessorEnablersOnDateWithAgent

RaceProcessorEnablerList getRaceProcessorEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                          throws OperationFailedException,
PermissionDeniedException

Gets a RaceProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned RaceProcessorEnabler 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.

getRaceProcessorEnablers

RaceProcessorEnablerList getRaceProcessorEnablers()
                                           throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned RaceProcessorEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.