Interface RaceConstrainerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RaceConstrainerSearchSession
public interface RaceConstrainerQuerySession extends OsidSession

This session provides methods for searching among RaceConstrainer objects. The search query is constructed using the RaceConstrainerQuery.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include race constrainer in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to race constrainer in this polls

Race constrainer may have a query record indicated by their respective record types. The query record is accessed via the RaceConstrainerQuery.

  • 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.

    • canSearchRaceConstrainers

      boolean canSearchRaceConstrainers()
      Tests if this user can perform RaceConstrainer 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method 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 race 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.

    • getRaceConstrainerQuery

      RaceConstrainerQuery getRaceConstrainerQuery()
      Gets a race constrainer query.
      Returns:
      the race constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainersByQuery

      RaceConstrainerList getRaceConstrainersByQuery(RaceConstrainerQuery raceConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RaceConstrainers matching the given race constrainer query.
      Parameters:
      raceConstrainerQuery - the race constrainer query
      Returns:
      the returned RaceConstrainerList
      Throws:
      NullArgumentException - raceConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceConstrainerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.