Interface RelevancyEnablerOntologySession

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

This session provides methods to retrieve RelevancyEnabler to Ontology mappings. A RelevancyEnabler may appear in multiple Ontology objects. Each ontology may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupRelevancyEnablerOntologyMappings

      boolean canLookupRelevancyEnablerOntologyMappings()
      Tests if this user can perform lookups of relevancy enabler/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeRelevancyEnablerOntologyView

      void useComparativeRelevancyEnablerOntologyView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryRelevancyEnablerOntologyView

      void usePlenaryRelevancyEnablerOntologyView()
      A complete view of the RelevancyEnabler and Ontology returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getRelevancyEnablerIdsByOntology

      IdList getRelevancyEnablerIdsByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of RelevancyEnablerIds associated with an Ontology .
      Parameters:
      ontologyId - Id of the Ontology
      Returns:
      list of related relevancy enabler Ids
      Throws:
      NotFoundException - ontologyId is not found
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablersByOntology

      RelevancyEnablerList getRelevancyEnablersByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of relevancy enablers associated with an Ontology .
      Parameters:
      ontologyId - Id of the Ontology
      Returns:
      list of related relevancy enablers
      Throws:
      NotFoundException - ontologyId is not found
      NullArgumentException - ontologyId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablerIdsByOntologies

      IdList getRelevancyEnablerIdsByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of RelevancyEnablerIds corresponding to a list of Ontologies .
      Parameters:
      ontologyIds - list of ontology Ids
      Returns:
      list of relevancy enabler Ids
      Throws:
      NullArgumentException - ontologyIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablersByOntologies

      RelevancyEnablerList getRelevancyEnablersByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of relevancy enablers corresponding to a list of Ontologies .
      Parameters:
      ontologyIds - list of ontology Ids
      Returns:
      list of relevancy enablers
      Throws:
      NullArgumentException - ontologyIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOntologyIdsByRelevancyEnabler

      IdList getOntologyIdsByRelevancyEnabler(Id relevancyEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Ontology Ids mapped to a RelevancyEnabler .
      Parameters:
      relevancyEnablerId - Id of a RelevancyEnabler
      Returns:
      list of ontologies
      Throws:
      NotFoundException - relevancyEnablerId is not found
      NullArgumentException - relevancyEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOntologiesByRelevancyEnabler

      OntologyList getOntologiesByRelevancyEnabler(Id relevancyEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Ontologies mapped to a RelevancyEnabler .
      Parameters:
      relevancyEnablerId - Id of a RelevancyEnabler
      Returns:
      list of ontologies
      Throws:
      NotFoundException - relevancyEnablerId is not found
      NullArgumentException - relevancyEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.