Interface BallotConstrainerSearchSession

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

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

getBallotConstrainersByQuery() is the basic search method and returns a list of BallotConstrainers. A more advanced search may be performed with getBallotConstrainersBySearch().It accepts a BallotConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getBallotConstrainersBySearch() returns a BallotConstrainerSearchResults that can be used to access the resulting BallotConstrainerList or be used to perform a search within the result set through BallotConstrainerSearch.

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
BallotConstrainers may have a query record indicated by their respective record types. The query record is accessed via the BallotConstrainerQuery.

  • Method Details

    • getBallotConstrainerSearch

      BallotConstrainerSearch getBallotConstrainerSearch()
      Gets a ballot constrainer search.
      Returns:
      the ballot constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerSearchOrder

      BallotConstrainerSearchOrder getBallotConstrainerSearchOrder()
      Gets a ballot constrainer search order. The BallotConstrainerSearchOrder is supplied to a BallotConstrainerSearch to specify the ordering of results.
      Returns:
      the ballot constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersBySearch

      BallotConstrainerSearchResults getBallotConstrainersBySearch(BallotConstrainerQuery ballotConstrainerQuery, BallotConstrainerSearch ballotConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      ballotConstrainerQuery - the ballot constrainer query
      ballotConstrainerSearch - the ballot constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - ballotConstrainerQuery or ballotConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ballotConstrainerQuery or ballotConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerQueryFromInspector

      BallotConstrainerQuery getBallotConstrainerQueryFromInspector(BallotConstrainerQueryInspector ballotConstrainerQueryInspector)
      Gets a ballot constrainer query from an inspector. The inspector is available from a BallotConstrainerSearchResults.
      Parameters:
      ballotConstrainerQueryInspector - a ballot constrainer query inspector
      Returns:
      the ballot constrainer query
      Throws:
      NullArgumentException - ballotConstrainerQueryInspector is null
      UnsupportedException - ballotConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.