Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface RelatedElementsManagementInterface

public interface RelatedElementsManagementInterface
Defines the interface that is common to multiple element types

  • Method Summary

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

  • Method Details

    • setupMoreInformation

      void setupMoreInformation(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties properties, String detailGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearMoreInformation

      void clearMoreInformation(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String detailGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getMoreInformation

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getMoreInformation(String userId, String elementGUID, 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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDescriptiveElements

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getDescriptiveElements(String userId, String detailGUID, 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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupStakeholder

      void setupStakeholder(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.projects.StakeholderProperties properties, String stakeholderGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearStakeholder

      void clearStakeholder(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String stakeholderGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getStakeholders

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getStakeholders(String userId, String elementGUID, 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
      Retrieve the stakeholder elements linked via the "Stakeholder" 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getStakeholderCommissionedElements

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getStakeholderCommissionedElements(String userId, String stakeholderGUID, 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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupAssignmentScope

      void setupAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.AssignmentScopeProperties properties, String scopeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearAssignmentScope

      void clearAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String scopeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAssignedScopes

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getAssignedScopes(String userId, String elementGUID, 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
      Retrieve the assigned scopes linked by the "AssignmentScope" 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAssignedActors

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getAssignedActors(String userId, String scopeGUID, 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
      Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
      Parameters:
      userId - calling user
      scopeGUID - unique identifier of the scope
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of related elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupResource

      void setupResource(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.resources.ResourceListProperties properties, String resourceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearResource

      void clearResource(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String resourceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getResourceList

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getResourceList(String userId, String elementGUID, 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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSupportedByResource

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getSupportedByResource(String userId, String resourceGUID, 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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)