Interface BallotConstrainerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BallotConstrainerSearchSession
public interface BallotConstrainerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchBallotConstrainers

      boolean canSearchBallotConstrainers()
      Tests if this user can perform BallotConstrainer 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 ballot constrainer in polls which are children of this broker 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.

    • getBallotConstrainerQuery

      BallotConstrainerQuery getBallotConstrainerQuery()
      Gets a ballot constrainer query.
      Returns:
      the ballot constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersByQuery

      BallotConstrainerList getBallotConstrainersByQuery(BallotConstrainerQuery ballotConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of BallotConstrainers matching the given ballot constrainer query.
      Parameters:
      ballotConstrainerQuery - the ballot constrainer query
      Returns:
      the returned BallotConstrainerList
      Throws:
      NullArgumentException - ballotConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ballotConstrainerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.