Package org.odpi.openmetadata.accessservices.communityprofile.client

Class CommunityProfileBaseClient

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
Direct Known Subclasses:
CommunityManagement, LocationManagement, UserIdentityManagement, ValidValueManagement
public class CommunityProfileBaseClient extends Object implements org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
CommunityProfileBaseClient supports the common properties and functions for the Community Profile OMAS.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)
    Create a new client that is going to be used in an OMAG Server.
    CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • 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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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.accessservices.communityprofile.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
    removeReferenceable(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String urlTemplate, String methodName)
    Remove the metadata element.
    void
    setupAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.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.accessservices.communityprofile.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.accessservices.communityprofile.properties.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.accessservices.communityprofile.properties.StakeholderProperties properties, String stakeholderGUID)
    Create a "Stakeholder" relationship between an element and its stakeholder.
    void
    updateRelationship(String userId, String externalSourceGUID, String externalSourceName, String primaryElementGUID, String primaryElementGUIDParameterName, org.odpi.openmetadata.accessservices.communityprofile.properties.RelationshipProperties properties, String secondaryElementGUID, String secondaryElementGUIDParameterName, boolean isMergeUpdate, String urlTemplate, String methodName)
    Update the properties of the relationship between two elements.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CommunityProfileBaseClient

      public CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileBaseClient

      public CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileBaseClient

      public CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileBaseClient

      public CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileBaseClient

      public CommunityProfileBaseClient(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • updateRelationship

      public void updateRelationship(String userId, String externalSourceGUID, String externalSourceName, String primaryElementGUID, String primaryElementGUIDParameterName, org.odpi.openmetadata.accessservices.communityprofile.properties.RelationshipProperties properties, String secondaryElementGUID, String secondaryElementGUIDParameterName, boolean isMergeUpdate, String urlTemplate, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update the properties of the relationship between two elements.
      Parameters:
      userId - the name of the calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      primaryElementGUID - unique identifier of the primary element
      primaryElementGUIDParameterName - name of parameter passing the primaryElementGUID
      properties - describes the properties for the relationship
      secondaryElementGUID - unique identifier of the element to connect it to
      secondaryElementGUIDParameterName - name of parameter passing the secondaryElementGUID
      isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
      urlTemplate - URL to call (no expected placeholders)
      methodName - calling method
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeReferenceable

      public void removeReferenceable(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String urlTemplate, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element.
      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 metadata element to remove
      elementGUIDParameterName - name of parameter passing the elementGUID
      urlTemplate - URL to call (no expected placeholders)
      methodName - calling method
      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)

    • setupMoreInformation

      public void setupMoreInformation(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      setupMoreInformation in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public 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.
      Specified by:
      clearMoreInformation in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getMoreInformation in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getDescriptiveElements in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public void setupStakeholder(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.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.
      Specified by:
      setupStakeholder in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public 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.
      Specified by:
      clearStakeholder in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getStakeholders in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getStakeholderCommissionedElements in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public void setupAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.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.
      Specified by:
      setupAssignmentScope in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public 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.
      Specified by:
      clearAssignmentScope in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getAssignedScopes in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getAssignedActors in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public void setupResource(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.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.
      Specified by:
      setupResource in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public 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.
      Specified by:
      clearResource in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getResourceList in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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

      public List<org.odpi.openmetadata.accessservices.communityprofile.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.
      Specified by:
      getSupportedByResource in interface org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface
      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)