Interface RaceConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RaceConstrainerEnablerQuerySession
public interface RaceConstrainerEnablerSearchSession extends RaceConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include race constrainer enablers in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to race constrainer enablers in this polls
RaceConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the RaceConstrainerEnablerQuery .

  • Method Details

    • getRaceConstrainerEnablerSearch

      RaceConstrainerEnablerSearch getRaceConstrainerEnablerSearch()
      Gets a race constrainer enabler search.
      Returns:
      the race constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainerEnablerSearchOrder

      RaceConstrainerEnablerSearchOrder getRaceConstrainerEnablerSearchOrder()
      Gets a race constrainer enabler search order. The RaceConstrainerEnablerSearchOrder is supplied to a RaceConstrainerEnablerSearch to specify the ordering of results.
      Returns:
      the race constrainer enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainerEnablersBySearch

      RaceConstrainerEnablerSearchResults getRaceConstrainerEnablersBySearch(RaceConstrainerEnablerQuery raceConstrainerEnablerQuery, RaceConstrainerEnablerSearch raceConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      raceConstrainerEnablerQuery - the race constrainer enabler query
      raceConstrainerEnablerSearch - the race constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - raceConstrainerEnablerQuery or raceConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceConstrainerEnablerQuery or raceConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainerEnablerQueryFromInspector

      RaceConstrainerEnablerQuery getRaceConstrainerEnablerQueryFromInspector(RaceConstrainerEnablerQueryInspector raceConstrainerEnablerQueryInspector)
      Gets a race constrainer enabler query from an inspector. The inspector is available from a RaceConstrainerEnablerSearchResults .
      Parameters:
      raceConstrainerEnablerQueryInspector - a race constrainer enabler query inspector
      Returns:
      the race constrainer enabler query
      Throws:
      NullArgumentException - raceConstrainerEnablerQueryInspector is null
      UnsupportedException - raceConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.