Package org.odpi.openmetadata.accessservices.assetowner.api

Interface ExternalReferencesInterface

public interface ExternalReferencesInterface
The ExternalReferencesInterface is used by the governance team to define external references to elements within the governance program.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createExternalReference(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties)
    Create a definition of an external reference.
    void
    deleteExternalReference(String userId, String externalReferenceGUID)
    Remove the definition of an external reference.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement>
    findExternalReferencesById(String userId, String resourceId, int startFrom, int pageSize)
    Retrieve the list of external references for this resourceId.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getElementsForExternalReference(String userId, String externalReferenceGUID, int startFrom, int pageSize)
    Return information about the elements linked to a externalReference.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement
    getExternalReferenceByGUID(String userId, String externalReferenceGUID)
    Return information about a specific external reference.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement>
    getExternalReferencesByURL(String userId, String url, int startFrom, int pageSize)
    Retrieve the list of external references for this URL.
    void
    linkExternalReferenceToElement(String userId, String attachedToGUID, String externalReferenceGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceLinkProperties linkProperties)
    Link an external reference to an object.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement>
    retrieveAttachedExternalReferences(String userId, String attachedToGUID, int startFrom, int pageSize)
    Retrieve the list of external references attached to the supplied object.
    void
    unlinkExternalReferenceFromElement(String userId, String attachedToGUID, String externalReferenceGUID)
    Remove the link between an external reference and an element.
    void
    updateExternalReference(String userId, String externalReferenceGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties)
    Update the definition of an external reference.

  • Method Details

    • createExternalReference

      String createExternalReference(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a definition of an external reference.
      Parameters:
      userId - calling user
      anchorGUID - optional element to link the external reference to that will act as an anchor - that is, this external reference will be deleted when the element is deleted (once the external reference is linked to the anchor).
      properties - properties for a external reference
      Returns:
      unique identifier of the external reference
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • updateExternalReference

      void updateExternalReference(String userId, String externalReferenceGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the definition of an external reference.
      Parameters:
      userId - calling user
      externalReferenceGUID - unique identifier of external reference
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      properties - properties to change
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • deleteExternalReference

      void deleteExternalReference(String userId, String externalReferenceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the definition of an external reference.
      Parameters:
      userId - calling user
      externalReferenceGUID - unique identifier of external reference
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null; guid is not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • linkExternalReferenceToElement

      void linkExternalReferenceToElement(String userId, String attachedToGUID, String externalReferenceGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceLinkProperties linkProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Link an external reference to an object.
      Parameters:
      userId - the name of the calling user.
      attachedToGUID - object linked to external references.
      linkProperties - description for the reference from the perspective of the object that the reference is being attached to.
      externalReferenceGUID - unique identifier (guid) of the external reference details.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - problem with the GUID or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • unlinkExternalReferenceFromElement

      void unlinkExternalReferenceFromElement(String userId, String attachedToGUID, String externalReferenceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Remove the link between an external reference and an element. If the element is its anchor, the external reference is removed.
      Parameters:
      userId - the name of the calling user.
      attachedToGUID - object linked to external references.
      externalReferenceGUID - identifier of the external reference.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - problem with the GUID or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getExternalReferenceByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement getExternalReferenceByGUID(String userId, String externalReferenceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about a specific external reference.
      Parameters:
      userId - calling user
      externalReferenceGUID - unique identifier for the external reference
      Returns:
      properties of the external reference
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - externalReferenceGUID or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • findExternalReferencesById

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement> findExternalReferencesById(String userId, String resourceId, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve the list of external references for this resourceId.
      Parameters:
      userId - the name of the calling user.
      resourceId - unique reference id assigned by the resource owner (supports wildcards). This is the qualified name of the entity
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      links to addition information.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getExternalReferencesByURL

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement> getExternalReferencesByURL(String userId, String url, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve the list of external references for this URL.
      Parameters:
      userId - the name of the calling user.
      url - URL of the external resource.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      links to addition information.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • retrieveAttachedExternalReferences

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ExternalReferenceElement> retrieveAttachedExternalReferences(String userId, String attachedToGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve the list of external references attached to the supplied object.
      Parameters:
      userId - the name of the calling user.
      attachedToGUID - object linked to external reference.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      links to addition information.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getElementsForExternalReference

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getElementsForExternalReference(String userId, String externalReferenceGUID, 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
      Return information about the elements linked to a externalReference.
      Parameters:
      userId - calling user
      externalReferenceGUID - unique identifier for the externalReference
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the related elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem