Interface OntologyProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
OntologyManager, OntologyProxyManager
public interface OntologyProfile extends OsidProfile

The OntologyProfile describes the interoperability among ontology services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if federation is visible.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectLookup

      boolean supportsSubjectLookup()
      Tests if a subject lookup service is supported. a subject lookup service defines methods to access subjects.
      Returns:
      true if subject lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectQuery

      boolean supportsSubjectQuery()
      Tests if a subject query service is supported.
      Returns:
      true if subject query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectSearch

      boolean supportsSubjectSearch()
      Tests if a subject search service is supported.
      Returns:
      true if subject search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectAdmin

      boolean supportsSubjectAdmin()
      Tests if a subject administrative service is supported.
      Returns:
      true if subject admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectNotification

      boolean supportsSubjectNotification()
      Tests if subject notification is supported. Messages may be sent when subjects are created, modified, or deleted.
      Returns:
      true if subject notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectHierarchy

      boolean supportsSubjectHierarchy()
      Tests if a subject hierarchy traversal is supported.
      Returns:
      true if a subject hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectHierarchyDesign

      boolean supportsSubjectHierarchyDesign()
      Tests if subject hierarchy design is supported.
      Returns:
      true if a subject hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectOntology

      boolean supportsSubjectOntology()
      Tests if a subject to ontology lookup session is available.
      Returns:
      true if subject ontology lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectOntologyAssignment

      boolean supportsSubjectOntologyAssignment()
      Tests if a subject to ontology assignment session is available.
      Returns:
      true if subject ontology assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectSmartOntology

      boolean supportsSubjectSmartOntology()
      Tests if a subject smart ontology session is available.
      Returns:
      true if subject smart ontology session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyLookup

      boolean supportsRelevancyLookup()
      Tests if a subject relevancy lookup service is supported.
      Returns:
      true if relevancy lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyQuery

      boolean supportsRelevancyQuery()
      Tests if a relevancy query service is supported.
      Returns:
      true if relevancy query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancySearch

      boolean supportsRelevancySearch()
      Tests if a relevancy search service is supported.
      Returns:
      true if relevancy search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyAdmin

      boolean supportsRelevancyAdmin()
      Tests if a relevancy administrative service is supported.
      Returns:
      true if relevancy admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyNotification

      boolean supportsRelevancyNotification()
      Tests if relevancy notification is supported. Messages may be sent when subject relevancies are created, modified, or deleted.
      Returns:
      true if relevancy notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyLookup

      boolean supportsOntologyLookup()
      Tests if an ontology lookup service is supported.
      Returns:
      true if ontology lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyOntology

      boolean supportsRelevancyOntology()
      Tests if a relevancy to ontology lookup session is available.
      Returns:
      true if relevancy ontology lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyOntologyAssignment

      boolean supportsRelevancyOntologyAssignment()
      Tests if a relevancy to ontology assignment session is available.
      Returns:
      true if relevancy ontology assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancySmartOntology

      boolean supportsRelevancySmartOntology()
      Tests if a relevancy smart ontology session is available.
      Returns:
      true if relevancy smart ontology session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyQuery

      boolean supportsOntologyQuery()
      Tests if an ontology query service is supported.
      Returns:
      true if ontology query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologySearch

      boolean supportsOntologySearch()
      Tests if an ontology search service is supported.
      Returns:
      true if ontology search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyAdmin

      boolean supportsOntologyAdmin()
      Tests if an ontology administrative service is supported.
      Returns:
      true if ontology admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyNotification

      boolean supportsOntologyNotification()
      Tests if ontology notification is supported. Messages may be sent when ontologies are created, modified, or deleted.
      Returns:
      true if ontology notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyHierarchy

      boolean supportsOntologyHierarchy()
      Tests if an ontology hierarchy traversal is supported.
      Returns:
      true if an ontology hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyHierarchyDesign

      boolean supportsOntologyHierarchyDesign()
      Tests if ontology hierarchy design is supported.
      Returns:
      true if an ontology hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyAssignment

      boolean supportsOntologyAssignment()
      Tests if Ids can be asssigned to ontologies.
      Returns:
      true if an ontology hassignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyBatch

      boolean supportsOntologyBatch()
      Tests if an ontology batch service is supported.
      Returns:
      true if ontology batch is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyRules

      boolean supportsOntologyRules()
      Tests if an ontology rules service is supported.
      Returns:
      true if ontology rules is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectRecordTypes

      TypeList getSubjectRecordTypes()
      Gets the supported Subject record types.
      Returns:
      a list containing the supported Subject record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectRecordType

      boolean supportsSubjectRecordType(Type subjectRecordType)
      Tests if the given Subject record type is supported.
      Parameters:
      subjectRecordType - a Type indicating a Subject record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - subjectRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectSearchRecordTypes

      TypeList getSubjectSearchRecordTypes()
      Gets the supported Subject search record types.
      Returns:
      a list containing the supported Subject search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectSearchRecordType

      boolean supportsSubjectSearchRecordType(Type subjectSearchRecordType)
      Tests if the given Subject search record type is supported.
      Parameters:
      subjectSearchRecordType - a Type indicating a Subject search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - subjectSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyRecordTypes

      TypeList getRelevancyRecordTypes()
      Gets the supported Relevancy record types.
      Returns:
      a list containing the supported Relevancy record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancyRecordType

      boolean supportsRelevancyRecordType(Type relevancyRecordType)
      Tests if the given Relevancy record type is supported.
      Parameters:
      relevancyRecordType - a Type indicating a Relevnacy record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - relevancyRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancySearchRecordTypes

      TypeList getRelevancySearchRecordTypes()
      Gets the supported Relevancy search record types.
      Returns:
      a list containing the supported Relevancy search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelevancySearchRecordType

      boolean supportsRelevancySearchRecordType(Type relevancySearchRecordType)
      Tests if the given Relevancy search record type is supported.
      Parameters:
      relevancySearchRecordType - a Type indicating a Relevancy search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - relevancySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOntologyRecordTypes

      TypeList getOntologyRecordTypes()
      Gets the supported Ontology record types.
      Returns:
      a list containing the supported Ontology record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologyRecordType

      boolean supportsOntologyRecordType(Type ontologyRecordType)
      Tests if the given Ontology record type is supported.
      Parameters:
      ontologyRecordType - a Type indicating an Ontology type
      Returns:
      true if the given ontology record Type is supported, false otherwise
      Throws:
      NullArgumentException - ontologyRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOntologySearchRecordTypes

      TypeList getOntologySearchRecordTypes()
      Gets the supported ontology search record types.
      Returns:
      a list containing the supported Ontology search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOntologySearchRecordType

      boolean supportsOntologySearchRecordType(Type ontologySearchRecordType)
      Tests if the given ontology search record type is supported.
      Parameters:
      ontologySearchRecordType - a Type indicating an Ontology search record type
      Returns:
      true if the given search record Type is supported, false otherwise
      Throws:
      NullArgumentException - ontologySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.