Package org.odpi.openmetadata.accessservices.digitalarchitecture.api

Interface ManageSubjectAreas

public interface ManageSubjectAreas
Subject areas group data into topic areas. This makes it easier to manage common definitions such as glossary terms, reference data and governance definitions that are specific to a certain type of data. The SubjectArea classification can be added to digital services and digital products.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSubjectAreaMemberClassification(String userId, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.SubjectAreaClassificationProperties properties)
    Add a subject area classification to a referenceable element.
    void
    deleteSubjectAreaMemberClassification(String userId, String elementGUID)
    Remove a subject area classification from a referenceable.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub>
    getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize)
    Return information about the contents of a subject area such as the digital services, digital products, glossaries, reference data sets and quality definitions.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SubjectAreaElement
    getSubjectAreaByName(String userId, String subjectAreaName)
    Return information about a specific subject area.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SubjectAreaElement>
    getSubjectAreas(String userId, int domainIdentifier, int startFrom, int pageSize)
    Return information about the defined subject areas.

  • Method Details

    • getSubjectAreaByName

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SubjectAreaElement getSubjectAreaByName(String userId, String subjectAreaName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about a specific subject area.
      Parameters:
      userId - calling user
      subjectAreaName - unique name for the subject area
      Returns:
      properties of the subject area
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getSubjectAreas

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SubjectAreaElement> getSubjectAreas(String userId, int domainIdentifier, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the defined subject areas.
      Parameters:
      userId - calling user
      domainIdentifier - identifier for the desired governance domain - if 0 then all subject areas are returned
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the subject areas
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSubjectAreaMemberClassification

      void addSubjectAreaMemberClassification(String userId, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.SubjectAreaClassificationProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a subject area classification to a referenceable element.
      Parameters:
      userId - calling user
      elementGUID - unique identifier for the element
      properties - identifier for a subject area
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • deleteSubjectAreaMemberClassification

      void deleteSubjectAreaMemberClassification(String userId, String elementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a subject area classification from a referenceable.
      Parameters:
      userId - calling user
      elementGUID - unique identifier for the element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null; guid is not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getMembersOfSubjectArea

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub> getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the contents of a subject area such as the digital services, digital products, glossaries, reference data sets and quality definitions.
      Parameters:
      userId - calling user
      subjectAreaName - unique identifier for the subject area
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the subject area members
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem