Interface RelevancyEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RelevancyEnablerQuerySession
public interface RelevancyEnablerSearchSession extends RelevancyEnablerQuerySession

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

getRelevancyEnablersByQuery() is the basic search method and returns a list of RelevancyEnablers . A more advanced search may be performed with getRelevancyEnablersBySearch() . It accepts a RelevancyEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRelevancyEnablersBySearch() returns a RelevancyEnablerSearchResults that can be used to access the resulting RelevancyEnablerList or be used to perform a search within the result set through RelevancyEnablerSearch .

This session defines views that offer differing behaviors for searching.

  • federated ontology view: searches include relevancy enablers in ontologies of which this ontology is an ancestor in the ontology hierarchy
  • isolated ontology view: searches are restricted to relevancy enablers in this ontology
RelevancyEnablers may have a query record indicated by their respective record types. The query record is accessed via the RelevancyEnablerQuery .

  • Method Details

    • getRelevancyEnablerSearch

      RelevancyEnablerSearch getRelevancyEnablerSearch()
      Gets a relevancy enabler search.
      Returns:
      the relevancy enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerSearchOrder

      RelevancyEnablerSearchOrder getRelevancyEnablerSearchOrder()
      Gets a relevancy enabler search order. The RelevancyEnablerSearchOrder is supplied to a RelevancyEnablerSearch to specify the ordering of results.
      Returns:
      the relevancy enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablersBySearch

      RelevancyEnablerSearchResults getRelevancyEnablersBySearch(RelevancyEnablerQuery relevancyEnablerQuery, RelevancyEnablerSearch relevancyEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      relevancyEnablerQuery - the relevancy enabler query
      relevancyEnablerSearch - the relevancy enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - relevancyEnablerQuery or relevancyEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relevancyEnablerQuery or relevancyEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerQueryFromInspector

      RelevancyEnablerQuery getRelevancyEnablerQueryFromInspector(RelevancyEnablerQueryInspector relevancyEnablerQueryInspector)
      Gets a relevancy enabler query from an inspector. The inspector is available from a RelevancyEnablerSearchResults .
      Parameters:
      relevancyEnablerQueryInspector - a relevancy enabler query inspector
      Returns:
      the relevancy enabler query
      Throws:
      NullArgumentException - relevancyEnablerQueryInspector is null
      UnsupportedException - relevancyEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.