Interface SubjectAreasInterface

  • All Known Implementing Classes:
    SubjectAreaManager

    public interface SubjectAreasInterface
    The SubjectAreasInterface is used by the governance team to define the subject area for topic related governance definitions.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createSubjectArea​(java.lang.String userId, SubjectAreaProperties properties)
      Create a definition of a subject area.
      void deleteSubjectArea​(java.lang.String userId, java.lang.String subjectAreaGUID)
      Remove the definition of a subject area.
      SubjectAreaElement getSubjectAreaByGUID​(java.lang.String userId, java.lang.String subjectAreaGUID)
      Return information about a specific subject area.
      SubjectAreaElement getSubjectAreaByName​(java.lang.String userId, java.lang.String qualifiedName)
      Return information about a specific subject area.
      SubjectAreaDefinition getSubjectAreaDefinitionByGUID​(java.lang.String userId, java.lang.String subjectAreaGUID)
      Return information about a specific subject area and its linked governance definitions.
      java.util.List<SubjectAreaElement> getSubjectAreasForDomain​(java.lang.String userId, int domainIdentifier, int startFrom, int pageSize)
      Return information about the defined subject areas.
      void linkSubjectAreasInHierarchy​(java.lang.String userId, java.lang.String parentSubjectAreaGUID, java.lang.String childSubjectAreaGUID)
      Link two related subject areas together as part of a hierarchy.
      void linkSubjectAreaToGovernanceDefinition​(java.lang.String userId, java.lang.String subjectAreaGUID, java.lang.String definitionGUID)
      Link a subject area to a governance definition that controls how the definitions in the subject area should be governed.
      void unlinkSubjectAreaFromGovernanceDefinition​(java.lang.String userId, java.lang.String subjectAreaGUID, java.lang.String definitionGUID)
      Remove the link between a subject area and a governance definition.
      void unlinkSubjectAreasInHierarchy​(java.lang.String userId, java.lang.String parentSubjectAreaGUID, java.lang.String childSubjectAreaGUID)
      Remove the link between two subject areas in the subject area hierarchy.
      void updateSubjectArea​(java.lang.String userId, java.lang.String subjectAreaGUID, boolean isMergeUpdate, SubjectAreaProperties properties)
      Update the definition of a subject area.