Interface BallotConstrainerEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BallotConstrainerEnablerSearchSession
public interface BallotConstrainerEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchBallotConstrainerEnablers

      boolean canSearchBallotConstrainerEnablers()
      Tests if this user can perform BallotConstrainerEnabler 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 enablers 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.

    • getBallotConstrainerEnablerQuery

      BallotConstrainerEnablerQuery getBallotConstrainerEnablerQuery()
      Gets a ballot constrainer enabler query.
      Returns:
      the ballot constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablersByQuery

      BallotConstrainerEnablerList getBallotConstrainerEnablersByQuery(BallotConstrainerEnablerQuery ballotConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of BallotConstrainerEnablers matching the given ballot constrainer enabler query.
      Parameters:
      ballotConstrainerEnablerQuery - the ballot constrainer enabler query
      Returns:
      the returned BallotConstrainerEnablerList
      Throws:
      NullArgumentException - ballotConstrainerEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ballotConstrainerEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.