Interface OntologyRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OntologyRulesProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface OntologyRulesManager extends OsidManager, OntologyRulesProfile

The ontology rules manager provides access to ontology rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RelevancyEnablerLookupSession : a session to retrieve relevancy enablers
  • RelevancyEnablerQuerySession : a session to query for relevancy enablers
  • RelevancyEnablerSearchSession : a session to search for relevancy enablers
  • RelevancyEnablerAdminSession : a session to create and delete relevancy enablers
  • RelevancyEnablerNotificationSession : a session to receive notifications pertaining to relevancy enabler changes
  • RelevancyEnablerOntologySession : a session to look up relevancy enabler ontology mappings
  • RelevancyEnablerOntologyAssignmentSession : a session to manage relevancy enabler to ontology mappings
  • RelevancyEnablerSmartOntologySession : a session to manage dynamic ontologies of relevancy enablers
  • RelevancyEnablerRuleLookupSession : a session to look up relevancy enabler to relevancy mappings
  • RelevancyEnablerRuleApplicationSession : a session to apply relevancy enablers to relevancies

  • Method Details

    • getRelevancyEnablerLookupSession

      RelevancyEnablerLookupSession getRelevancyEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler lookup service.
      Returns:
      a RelevancyEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerLookup()} is {@code true} .

    • getRelevancyEnablerLookupSessionForOntology

      RelevancyEnablerLookupSession getRelevancyEnablerLookupSessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler lookup service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerLookupSession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getRelevancyEnablerQuerySession

      RelevancyEnablerQuerySession getRelevancyEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler query service.
      Returns:
      a RelevancyEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerQuery()} is {@code true} .

    • getRelevancyEnablerQuerySessionForOntology

      RelevancyEnablerQuerySession getRelevancyEnablerQuerySessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler query service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerQuerySession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true}

    • getRelevancyEnablerSearchSession

      RelevancyEnablerSearchSession getRelevancyEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler search service.
      Returns:
      a RelevancyEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerSearch()} is {@code true} .

    • getRelevancyEnablerSearchSessionForOntology

      RelevancyEnablerSearchSession getRelevancyEnablerSearchSessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enablers earch service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerSearchSession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getRelevancyEnablerAdminSession

      RelevancyEnablerAdminSession getRelevancyEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler administration service.
      Returns:
      a RelevancyEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerAdmin()} is {@code true} .

    • getRelevancyEnablerAdminSessionForOntology

      RelevancyEnablerAdminSession getRelevancyEnablerAdminSessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler administration service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerAdminSession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getRelevancyEnablerNotificationSession

      RelevancyEnablerNotificationSession getRelevancyEnablerNotificationSession(RelevancyEnablerReceiver relevancyEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler notification service.
      Parameters:
      relevancyEnablerReceiver - the notification callback
      Returns:
      a RelevancyEnablerNotificationSession
      Throws:
      NullArgumentException - relevancyEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerNotification()} is {@code true} .

    • getRelevancyEnablerNotificationSessionForOntology

      RelevancyEnablerNotificationSession getRelevancyEnablerNotificationSessionForOntology(RelevancyEnablerReceiver relevancyEnablerReceiver, Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler notification service for the given ontology.
      Parameters:
      relevancyEnablerReceiver - the notification callback
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerNotificationSession
      Throws:
      NotFoundException - no ontology found by the given Id
      NullArgumentException - relevancyEnablerReceiver or ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getRelevancyEnablerOntologySession

      RelevancyEnablerOntologySession getRelevancyEnablerOntologySession() throws OperationFailedException
      Gets the OsidSession to lookup relevancy enabler/ontology mappings for relevancy enablers.
      Returns:
      a RelevancyEnablerOntologySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerOntology() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerOntology()} is {@code true} .

    • getRelevancyEnablerOntologyAssignmentSession

      RelevancyEnablerOntologyAssignmentSession getRelevancyEnablerOntologyAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning relevancy enablers to ontologies for relevancy.
      Returns:
      a RelevancyEnablerOntologyAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerOntologyAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerOntologyAssignment()} is {@code true} .

    • getRelevancyEnablerSmartOntologySession

      RelevancyEnablerSmartOntologySession getRelevancyEnablerSmartOntologySession(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage relevancy enabler smart ontologies.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerSmartOntologySession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerSmartOntology() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerSmartOntology()} is {@code true} .

    • getRelevancyEnablerRuleLookupSession

      RelevancyEnablerRuleLookupSession getRelevancyEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler mapping lookup service.
      Returns:
      a RelevancyEnablerRuleSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerRuleLookup()} is {@code true} .

    • getRelevancyEnablerRuleLookupSessionForOntology

      RelevancyEnablerRuleLookupSession getRelevancyEnablerRuleLookupSessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler mapping lookup service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerRuleLookupSession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getRelevancyEnablerRuleApplicationSession

      RelevancyEnablerRuleApplicationSession getRelevancyEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the relevancy enabler assignment service.
      Returns:
      a RelevancyEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerRuleApplication()} is {@code true} .

    • getRelevancyEnablerRuleApplicationSessionForOntology

      RelevancyEnablerRuleApplicationSession getRelevancyEnablerRuleApplicationSessionForOntology(Id ontologyId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the relevancy enabler assignment service for the given ontology.
      Parameters:
      ontologyId - the Id of the Ontology
      Returns:
      a RelevancyEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Ontology found by the given Id
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRelevancyEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelevancyEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .