Interface RelatedElementsManagementInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAssignmentScope​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String scopeGUID)
      Remove an "AssignmentScope" relationship between two referenceables.
      void clearMoreInformation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String detailGUID)
      Remove a "MoreInformation" relationship between two referenceables.
      void clearResource​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String resourceGUID)
      Remove a "ResourceList" relationship between two referenceables.
      void clearStakeholder​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String stakeholderGUID)
      Remove a "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getAssignedActors​(java.lang.String userId, java.lang.String scopeGUID, int startFrom, int pageSize)
      Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
      java.util.List<RelatedElement> getAssignedScopes​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
      java.util.List<RelatedElement> getDescriptiveElements​(java.lang.String userId, java.lang.String detailGUID, int startFrom, int pageSize)
      Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
      java.util.List<RelatedElement> getMoreInformation​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
      java.util.List<RelatedElement> getResourceList​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
      java.util.List<RelatedElement> getStakeholderCommissionedElements​(java.lang.String userId, java.lang.String stakeholderGUID, int startFrom, int pageSize)
      Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getStakeholders​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getSupportedByResource​(java.lang.String userId, java.lang.String resourceGUID, int startFrom, int pageSize)
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      void setupAssignmentScope​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, AssignmentScopeProperties properties, java.lang.String scopeGUID)
      Create an "AssignmentScope" relationship between an element and its scope.
      void setupMoreInformation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, RelationshipProperties properties, java.lang.String detailGUID)
      Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
      void setupResource​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ResourceListProperties properties, java.lang.String resourceGUID)
      Create a "ResourceList" relationship between a consuming element and an element that represents resources.
      void setupStakeholder​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, StakeholderProperties properties, java.lang.String stakeholderGUID)
      Create a "Stakeholder" relationship between an element and its stakeholder.
    • Method Detail

      • setupMoreInformation

        void setupMoreInformation​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String elementGUID,
                                  RelationshipProperties properties,
                                  java.lang.String detailGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element that is descriptive
        properties - properties of the relationship
        detailGUID - unique identifier of the element that provides the detail
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearMoreInformation

        void clearMoreInformation​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String elementGUID,
                                  java.lang.String detailGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove a "MoreInformation" relationship between two referenceables.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element that is descriptive
        detailGUID - unique identifier of the element that provides the detail
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getMoreInformation

        java.util.List<RelatedElement> getMoreInformation​(java.lang.String userId,
                                                          java.lang.String elementGUID,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
        Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
        Parameters:
        userId - calling user
        elementGUID - unique identifier of the element that is descriptive
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getDescriptiveElements

        java.util.List<RelatedElement> getDescriptiveElements​(java.lang.String userId,
                                                              java.lang.String detailGUID,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
        Parameters:
        userId - calling user
        detailGUID - unique identifier of the element that provides the detail
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupStakeholder

        void setupStakeholder​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String elementGUID,
                              StakeholderProperties properties,
                              java.lang.String stakeholderGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Create a "Stakeholder" relationship between an element and its stakeholder.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        properties - properties of the relationship
        stakeholderGUID - unique identifier of the stakeholder
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearStakeholder

        void clearStakeholder​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String elementGUID,
                              java.lang.String stakeholderGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove a "Stakeholder" relationship between two referenceables.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        stakeholderGUID - unique identifier of the stakeholder
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getStakeholderCommissionedElements

        java.util.List<RelatedElement> getStakeholderCommissionedElements​(java.lang.String userId,
                                                                          java.lang.String stakeholderGUID,
                                                                          int startFrom,
                                                                          int pageSize)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
        Parameters:
        userId - calling user
        stakeholderGUID - unique identifier of the stakeholder
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupAssignmentScope

        void setupAssignmentScope​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String elementGUID,
                                  AssignmentScopeProperties properties,
                                  java.lang.String scopeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create an "AssignmentScope" relationship between an element and its scope.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        properties - properties of the relationship
        scopeGUID - unique identifier of the scope
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearAssignmentScope

        void clearAssignmentScope​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String elementGUID,
                                  java.lang.String scopeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove an "AssignmentScope" relationship between two referenceables.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        scopeGUID - unique identifier of the scope
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupResource

        void setupResource​(java.lang.String userId,
                           java.lang.String externalSourceGUID,
                           java.lang.String externalSourceName,
                           java.lang.String elementGUID,
                           ResourceListProperties properties,
                           java.lang.String resourceGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Create a "ResourceList" relationship between a consuming element and an element that represents resources.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        properties - properties of the relationship
        resourceGUID - unique identifier of the resource
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearResource

        void clearResource​(java.lang.String userId,
                           java.lang.String externalSourceGUID,
                           java.lang.String externalSourceName,
                           java.lang.String elementGUID,
                           java.lang.String resourceGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Remove a "ResourceList" relationship between two referenceables.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        resourceGUID - unique identifier of the resource
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getResourceList

        java.util.List<RelatedElement> getResourceList​(java.lang.String userId,
                                                       java.lang.String elementGUID,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
        Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
        Parameters:
        userId - calling user
        elementGUID - unique identifier of the element
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getSupportedByResource

        java.util.List<RelatedElement> getSupportedByResource​(java.lang.String userId,
                                                              java.lang.String resourceGUID,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
        Parameters:
        userId - calling user
        resourceGUID - unique identifier of the resource
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)