Interface ExternalReferenceManagerInterface

  • All Known Implementing Classes:
    ExternalReferenceManagerClient

    public interface ExternalReferenceManagerInterface
    ExternalReferenceManagerInterface defines the Java API for managing external references. External references are links to external resources such as documents and APIs.
    • Method Detail

      • createExternalReference

        java.lang.String createExternalReference​(java.lang.String userId,
                                                 java.lang.String anchorGUID,
                                                 java.lang.String linkId,
                                                 java.lang.String linkDescription,
                                                 ExternalReferenceProperties properties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create a definition of a 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
        linkId - identifier for the reference from the perspective of the anchor object that the reference is being attached to.
        linkDescription - description for the reference from the perspective of the anchor object that the reference is being attached to.
        properties - properties for a external reference
        Returns:
        unique identifier of the external reference
        Throws:
        InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • linkExternalReferenceToElement

        void linkExternalReferenceToElement​(java.lang.String userId,
                                            java.lang.String attachedToGUID,
                                            java.lang.String linkId,
                                            java.lang.String linkDescription,
                                            java.lang.String externalReferenceGUID)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException
        Link an external reference to an object.
        Parameters:
        userId - the name of the calling user.
        attachedToGUID - object linked to external references.
        linkId - identifier for the reference from the perspective of the object that the reference is being attached to.
        linkDescription - 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:
        InvalidParameterException - problem with the GUID or the external references are not correctly specified, or are null.
        PropertyServerException - the server is not available.
        UserNotAuthorizedException - the calling user is not authorized to issue the call.
      • unlinkExternalReferenceFromElement

        void unlinkExternalReferenceFromElement​(java.lang.String userId,
                                                java.lang.String attachedToGUID,
                                                java.lang.String externalReferenceGUID)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException
        Remove the link between a 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:
        InvalidParameterException - problem with the GUID or the external references are not correctly specified, or are null.
        PropertyServerException - the server is not available.
        UserNotAuthorizedException - the calling user is not authorized to issue the call.
      • findExternalReferencesById

        java.util.List<ExternalReferenceElement> findExternalReferencesById​(java.lang.String userId,
                                                                            java.lang.String resourceId,
                                                                            int startFrom,
                                                                            int pageSize)
                                                                     throws InvalidParameterException,
                                                                            PropertyServerException,
                                                                            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:
        InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
        PropertyServerException - the server is not available.
        UserNotAuthorizedException - the calling user is not authorized to issue the call.
      • retrieveAttachedExternalReferences

        java.util.List<ExternalReferenceElement> retrieveAttachedExternalReferences​(java.lang.String userId,
                                                                                    java.lang.String attachedToGUID,
                                                                                    int startFrom,
                                                                                    int pageSize)
                                                                             throws InvalidParameterException,
                                                                                    PropertyServerException,
                                                                                    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:
        InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
        PropertyServerException - the server is not available.
        UserNotAuthorizedException - the calling user is not authorized to issue the call.