Interface CommissionEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, CommissionEnablerQuerySession, OsidSession, OsidSession
public interface CommissionEnablerSearchSession extends CommissionEnablerQuerySession

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

getCommissionEnablersByQuery() is the basic search method and returns a list of CommissionEnablers . A more advanced search may be performed with getCommissionEnablersBySearch() . It accepts a CommissionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getCommissionEnablersBySearch() returns a CommissionEnablerSearchResults that can be used to access the resulting CommissionEnablerList or be used to perform a search within the result set through CommissionEnablerSearch .

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include commission enabler in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to commission enabler in this foundry
CommissionEnablers may have a commission enabler query record indicated by their respective record types. The commission enabler query record is accessed via the CommissionEnablerQuery .

  • Method Details

    • getCommissionEnablerSearch

      CommissionEnablerSearch getCommissionEnablerSearch()
      Gets a commission enabler search.
      Returns:
      the commission enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablerSearchOrder

      CommissionEnablerSearchOrder getCommissionEnablerSearchOrder()
      Gets a commission enabler search order. The CommissionEnablerSearchOrder is supplied to a CommissionEnablerSearch to specify the ordering of results.
      Returns:
      the commission enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersBySearch

      CommissionEnablerSearchResults getCommissionEnablersBySearch(CommissionEnablerQuery commissionEnablerQuery, CommissionEnablerSearch commissionEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      commissionEnablerQuery - the commission enabler query
      commissionEnablerSearch - the commission enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - commissionEnablerQuery or commissionEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - commissionEnablerQuery or commissionEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablerQueryFromInspector

      CommissionEnablerQuery getCommissionEnablerQueryFromInspector(CommissionEnablerQueryInspector ccommissionEnablerQueryInspector)
      Gets a commission enabler query from an inspector. The inspector is available from a CommissionEnablerSearchResults .
      Parameters:
      ccommissionEnablerQueryInspector - a commission enabler query inspector
      Returns:
      the commission enabler query
      Throws:
      NullArgumentException - commissionEnablerQueryInspector is null
      UnsupportedException - commissionEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.