Interface RelevancyEnablerSmartOntologySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RelevancyEnablerSmartOntologySession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic ontologies. A RelevancyEnablerQuery can be retrieved from this session and mapped to this Ontology to create a virtual collection of relevancy enablers. The relevancy enablers may be sequenced using the RelevancyEnablerSearchOrder from this session.

This Ontology has a default query that matches any relevancy enabler and a default search order that specifies no sequencing. The queries may be examined using a RelevancyEnablerQueryInspector . The query may be modified by converting the inspector back to a RelevancyEnablerQuery .

  • Method Details

    • getOntologyId

      Id getOntologyId()
      Gets the Ontology Id associated with this session.
      Returns:
      the Ontology Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOntology

      Ontology getOntology() throws OperationFailedException, PermissionDeniedException
      Gets the Ontology associated with this session.
      Returns:
      the ontology
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartOntologies

      boolean canManageSmartOntologies()
      Tests if this user can manage smart ontologies. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart ontology management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerQuery

      RelevancyEnablerQuery getRelevancyEnablerQuery()
      Gets a relevancy enabler query.
      Returns:
      the relevancy enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerSearchOrder

      RelevancyEnablerSearchOrder getRelevancyEnablerSearchOrder()
      Gets a relevancy enabler search order.
      Returns:
      the relevancy enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRelevancyEnablerQuery

      void applyRelevancyEnablerQuery(RelevancyEnablerQuery relevancyEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a relevancy enabler query to this ontology.
      Parameters:
      relevancyEnablerQuery - the relevancy enabler query
      Throws:
      NullArgumentException - relevancyEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - relevancyEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectRelevancyEnablerQuery

      RelevancyEnablerQueryInspector inspectRelevancyEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a relevancy enabler query inspector for this ontology.
      Returns:
      the relevancy enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyRelevancyEnablerSequencing

      void applyRelevancyEnablerSequencing(RelevancyEnablerSearchOrder relevancyEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a relevancy enabler search order to this ontology.
      Parameters:
      relevancyEnablerSearchOrder - the relevancy enabler search order
      Throws:
      NullArgumentException - relevancyEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - relevancyEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerQueryFromInspector

      RelevancyEnablerQuery getRelevancyEnablerQueryFromInspector(RelevancyEnablerQueryInspector relevancyEnablerQueryInspector)
      Gets a relevancy enabler query from an inspector.
      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.