OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceProcessorLookupSession
Implementsosid.OsidSession
Description

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.

MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe polls
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupRaceProcessors
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRaceProcessorView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRaceProcessorView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedPollsView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPollsView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveRaceProcessorView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusRaceProcessorView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRaceProcessor
Description

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.

Parametersosid.id.IdraceProcessorId Id of the RaceProcessor
Returnosid.voting.rules.RaceProcessorthe race processor
ErrorsNOT_FOUND raceProcessorId not found
NULL_ARGUMENT raceProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetRaceProcessorsByIds
Description

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.

Parametersosid.id.IdListraceProcessorIdsthe list of Ids to retrieve
Returnosid.voting.rules.RaceProcessorListthe returned RaceProcessor list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT raceProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorsByGenusType
Description

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.

Parametersosid.type.TyperaceProcessorGenusTypea race processor genus type
Returnosid.voting.rules.RaceProcessorListthe returned RaceProcessor list
ErrorsNULL_ARGUMENT raceProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorsByParentGenusType
Description

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.

Parametersosid.type.TyperaceProcessorGenusTypea race processor genus type
Returnosid.voting.rules.RaceProcessorListthe returned RaceProcessor list
ErrorsNULL_ARGUMENT raceProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorsByRecordType
Description

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.

Parametersosid.type.TyperaceProcessorRecordTypea race processor record type
Returnosid.voting.rules.RaceProcessorListthe returned RaceProcessor list
ErrorsNULL_ARGUMENT raceProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessors
Description

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.

Returnosid.voting.rules.RaceProcessorListthe returned RaceProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.