Interface RaceConstrainerLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RaceConstrainerLookupSession extends OsidSession

This session provides methods for retrieving RaceConstrainers .

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

    • canLookupRaceConstrainers

      boolean canLookupRaceConstrainers()
      Tests if this user can perform RaceConstrainers 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.

    • useComparativeRaceConstrainerView

      void useComparativeRaceConstrainerView()
      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.

    • usePlenaryRaceConstrainerView

      void usePlenaryRaceConstrainerView()
      A complete view of the RaceConstrainer 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 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.

    • useActiveRaceConstrainerView

      void useActiveRaceConstrainerView()
      Only active race constrainer are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusRaceConstrainerView

      void useAnyStatusRaceConstrainerView()
      All active and inactive race constrainers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getRaceConstrainer

      RaceConstrainer getRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceConstrainer specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned RaceConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to a RaceConstrainer and retained for compatibility. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Parameters:
      raceConstrainerId - Id of the RaceConstrainer
      Returns:
      the race constrainer
      Throws:
      NotFoundException - raceConstrainerId not found
      NullArgumentException - raceConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getRaceConstrainersByIds

      RaceConstrainerList getRaceConstrainersByIds(IdList raceConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a RaceConstrainerList corresponding to the given IdList . In plenary mode, the returned list contains all of the race constrainer 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 RaceConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Parameters:
      raceConstrainerIds - the list of Ids to retrieve
      Returns:
      the returned RaceConstrainer list
      Throws:
      NotFoundException - a Id was not found
      NullArgumentException - raceConstrainerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainersByGenusType

      RaceConstrainerList getRaceConstrainersByGenusType(Type raceConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RaceConstrainerList corresponding to the given race constrainer genus Type which does not include race constrainer of genus types derived from the specified Type . In plenary mode, the returned list contains all known race constrainer or an error results. Otherwise, the returned list may contain only those race constrainer that are accessible through this session. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Parameters:
      raceConstrainerGenusType - a race constrainer genus type
      Returns:
      the returned RaceConstrainer list
      Throws:
      NullArgumentException - raceConstrainerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainersByParentGenusType

      RaceConstrainerList getRaceConstrainersByParentGenusType(Type raceConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RaceConstrainerList corresponding to the given race constrainer genus Type and include any additional race constrainer with genus types derived from the specified Type . In plenary mode, the returned list contains all known race constrainer or an error results. Otherwise, the returned list may contain only those race constrainer that are accessible through this session. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Parameters:
      raceConstrainerGenusType - a race constrainer genus type
      Returns:
      the returned RaceConstrainer list
      Throws:
      NullArgumentException - raceConstrainerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainersByRecordType

      RaceConstrainerList getRaceConstrainersByRecordType(Type raceConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RaceConstrainerList containing the given race constrainer record Type . In plenary mode, the returned list contains all known race constrainer or an error results. Otherwise, the returned list may contain only those race constrainer that are accessible through this session. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Parameters:
      raceConstrainerRecordType - a race constrainer record type
      Returns:
      the returned RaceConstrainer list
      Throws:
      NullArgumentException - raceConstrainerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainers

      RaceConstrainerList getRaceConstrainers() throws OperationFailedException, PermissionDeniedException
      Gets all RaceConstrainers . In plenary mode, the returned list contains all known race constrainer or an error results. Otherwise, the returned list may contain only those race constrainer that are accessible through this session. In active mode, race constrainers are returned that are currently active. In any status mode, active and inactive race constrainer are returned.
      Returns:
      the returned RaceConstrainer list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.