Package org.odpi.openmetadata.accessservices.governanceprogram.server

Class SubjectAreaRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.SubjectAreaRESTServices
public class SubjectAreaRESTServices extends Object
SubjectAreaRESTServices provides the server side logic for the Governance SubjectArea Manager. It manages the definitions of subject areas and their linkage to the rest of the governance program.

  • Constructor Details

    • SubjectAreaRESTServices

      public SubjectAreaRESTServices()
      Default constructor

  • Method Details

    • createSubjectArea

      public GUIDResponse createSubjectArea(String serverName, String userId, ReferenceableRequestBody requestBody)
      Create a definition of a subject area.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new subjectArea or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateSubjectArea

      public VoidResponse updateSubjectArea(String serverName, String userId, String subjectAreaGUID, boolean isMergeUpdate, ReferenceableRequestBody requestBody)
      Update the definition of a subjectArea.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier of subjectArea
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      requestBody - properties to change
      Returns:
      void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteSubjectArea

      public VoidResponse deleteSubjectArea(String serverName, String userId, String subjectAreaGUID, ExternalSourceRequestBody requestBody)
      Remove the definition of a subjectArea.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier of subjectArea
      requestBody - external source request body
      Returns:
      void or InvalidParameterException guid or userId is null; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • linkSubjectAreasInHierarchy

      public VoidResponse linkSubjectAreasInHierarchy(String serverName, String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID, RelationshipRequestBody requestBody)
      Link two related subject areas together as part of a hierarchy. A subjectArea can only have one parent but many child subjectAreas.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      parentSubjectAreaGUID - unique identifier of the parent subjectArea
      childSubjectAreaGUID - unique identifier of the child subjectArea
      requestBody - relationship requestBody
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlinkSubjectAreasInHierarchy

      public VoidResponse unlinkSubjectAreasInHierarchy(String serverName, String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID, RelationshipRequestBody requestBody)
      Remove the link between two subjectAreas in the subjectArea hierarchy.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      parentSubjectAreaGUID - unique identifier of the parent subjectArea
      childSubjectAreaGUID - unique identifier of the child subjectArea
      requestBody - relationship requestBody
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • linkSubjectAreaToGovernanceDefinition

      public VoidResponse linkSubjectAreaToGovernanceDefinition(String serverName, String userId, String subjectAreaGUID, String definitionGUID, RelationshipRequestBody requestBody)
      Link a subject area to a governance definition that controls how the assets in the subjectArea should be governed.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier of the subjectArea
      definitionGUID - unique identifier of the governance definition
      requestBody - relationship requestBody
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlinkSubjectAreaFromGovernanceDefinition

      public VoidResponse unlinkSubjectAreaFromGovernanceDefinition(String serverName, String userId, String subjectAreaGUID, String definitionGUID, RelationshipRequestBody requestBody)
      Remove the link between a subjectArea and a governance definition.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier of the subjectArea
      definitionGUID - unique identifier of the governance definition
      requestBody - relationship requestBody
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getSubjectAreaByGUID

      public SubjectAreaResponse getSubjectAreaByGUID(String serverName, String userId, String subjectAreaGUID)
      Return information about a specific subject area.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier for the subjectArea
      Returns:
      properties of the subject area or InvalidParameterException subjectAreaGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getSubjectAreaByName

      public SubjectAreaResponse getSubjectAreaByName(String serverName, String userId, String qualifiedName)
      Return information about a specific subject area.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      qualifiedName - unique name for the subjectArea
      Returns:
      properties of the subject area or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getSubjectAreasForDomain

      public SubjectAreaListResponse getSubjectAreasForDomain(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
      Return information about the defined subject areas.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      domainIdentifier - identifier for the desired governance domain - 0 for all domains
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the subject area or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getSubjectAreaDefinitionByGUID

      public SubjectAreaDefinitionResponse getSubjectAreaDefinitionByGUID(String serverName, String userId, String subjectAreaGUID)
      Return information about a specific subject area and its linked governance definitions.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaGUID - unique identifier for the subjectArea
      Returns:
      properties of the subject area linked to the associated governance definitions or InvalidParameterException subjectAreaGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • addSubjectAreaMemberClassification

      public VoidResponse addSubjectAreaMemberClassification(String serverName, String userId, String elementGUID, ClassificationRequestBody requestBody)
      Add a subject area classification to a referenceable element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier for the element
      requestBody - identifier for a subject area
      Returns:
      void or InvalidParameterException qualifiedName or userId is null; qualifiedName is not unique PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteSubjectAreaMemberClassification

      public VoidResponse deleteSubjectAreaMemberClassification(String serverName, String userId, String elementGUID, ExternalSourceRequestBody requestBody)
      Remove a subject area classification from a referenceable.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier for the element
      requestBody - external source request body
      Returns:
      void or InvalidParameterException guid or userId is null; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getMembersOfSubjectArea

      public ElementStubListResponse getMembersOfSubjectArea(String serverName, String userId, String subjectAreaName, int startFrom, int pageSize)
      Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      subjectAreaName - unique identifier for the subject area
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of subject area members or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem