org.osid.voting.rules

Interface RaceProcessorLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RaceProcessorLookupSession
extends OsidSession

This session provides methods for retrieving RaceProcessors.

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 methods in this session operate, retrieve and pertain to race processor defined explicitly in the current polls. Using an isolated view is useful for managing RaceProcessors with the RaceProcessorAdminSession.
• federated polls view: All race processor methods in this session operate, retrieve and pertain to all race processor defined in this polls and any other race processor implicitly available in this polls through polls inheritence.
• active race processor view: All race processor lookup methods return active race processors.
• any status race processor view: Race processors 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

Methods

Modifier and Type	Method and Description
boolean	canLookupRaceProcessors() Tests if this user can perform RaceProcessors lookups.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
RaceProcessor	getRaceProcessor(Id raceProcessorId) Gets the RaceProcessor specified by its Id.
RaceProcessorList	getRaceProcessors() Gets all RaceProcessors.
RaceProcessorList	getRaceProcessorsByGenusType(Type raceProcessorGenusType) Gets a RaceProcessorList corresponding to the given race processor genus Type which does not include race processor of genus types derived from the specified Type.
RaceProcessorList	getRaceProcessorsByIds(IdList raceProcessorIds) Gets a RaceProcessorList corresponding to the given IdList.
RaceProcessorList	getRaceProcessorsByParentGenusType(Type raceProcessorGenusType) Gets a RaceProcessorList corresponding to the given race processor genus Type and include any additional race processor with genus types derived from the specified Type.
RaceProcessorList	getRaceProcessorsByRecordType(Type raceProcessorRecordType) Gets a RaceProcessorList containing the given race processor record Type.
void	useActiveRaceProcessorView() Only active race processors are returned by methods in this session.
void	useAnyStatusRaceProcessorView() All active and inactive race processors are returned by methods in this session.
void	useComparativeRaceProcessorView() 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	usePlenaryRaceProcessorView() A complete view of the RaceProcessor returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canLookupRaceProcessors

boolean canLookupRaceProcessors()

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

useComparativeRaceProcessorView

void useComparativeRaceProcessorView()

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.

usePlenaryRaceProcessorView

void usePlenaryRaceProcessorView()

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

useActiveRaceProcessorView

void useActiveRaceProcessorView()

Only active race processors are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusRaceProcessorView

void useAnyStatusRaceProcessorView()

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

Compliance:

mandatory - This method is must be implemented.

getRaceProcessor

RaceProcessor getRaceProcessor(Id raceProcessorId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

raceProcessorId - Id of the RaceProcessor

Returns:

the race processor

Throws:

NotFoundException - raceProcessorId not found

NullArgumentException - raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceProcessorsByIds

RaceProcessorList getRaceProcessorsByIds(IdList raceProcessorIds)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

raceProcessorIds - the list of Ids to retrieve

Returns:

the returned RaceProcessor list

Throws:

NotFoundException - a Id was not found

NullArgumentException - raceProcessorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsByGenusType

RaceProcessorList getRaceProcessorsByGenusType(Type raceProcessorGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

raceProcessorGenusType - a race processor genus type

Returns:

the returned RaceProcessor list

Throws:

NullArgumentException - raceProcessorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsByParentGenusType

RaceProcessorList getRaceProcessorsByParentGenusType(Type raceProcessorGenusType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

raceProcessorGenusType - a race processor genus type

Returns:

the returned RaceProcessor list

Throws:

NullArgumentException - raceProcessorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsByRecordType

RaceProcessorList getRaceProcessorsByRecordType(Type raceProcessorRecordType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

raceProcessorRecordType - a race processor record type

Returns:

the returned RaceProcessor list

Throws:

NullArgumentException - raceProcessorRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessors

RaceProcessorList getRaceProcessors()
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Returns:

the returned RaceProcessor list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.