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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
createExternalReference(java.lang.String userId, java.lang.String anchorGUID, java.lang.String linkId, java.lang.String linkDescription, ExternalReferenceProperties properties)
Create a definition of a external reference.void
deleteExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID)
Remove the definition of a external reference.java.util.List<ExternalReferenceElement>
findExternalReferencesById(java.lang.String userId, java.lang.String resourceId, int startFrom, int pageSize)
Retrieve the list of external references for this resourceId.java.util.List<ExternalReferenceElement>
findExternalReferencesByURL(java.lang.String userId, java.lang.String url, int startFrom, int pageSize)
Retrieve the list of external references for this URL.ExternalReferenceElement
getExternalReferenceByGUID(java.lang.String userId, java.lang.String externalReferenceGUID)
Return information about a specific external reference.void
linkExternalReferenceToElement(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String linkId, java.lang.String linkDescription, java.lang.String externalReferenceGUID)
Link an external reference to an object.java.util.List<ExternalReferenceElement>
retrieveAttachedExternalReferences(java.lang.String userId, java.lang.String attachedToGUID, int startFrom, int pageSize)
Retrieve the list of external references attached to the supplied object.void
unlinkExternalReferenceFromElement(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String externalReferenceGUID)
Remove the link between a external reference and an element.void
updateExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID, boolean isMergeUpdate, ExternalReferenceProperties properties)
Update the definition of a external reference.
-
-
-
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 useranchorGUID
- 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 deletedlinkId
- 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 uniquePropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
updateExternalReference
void updateExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID, boolean isMergeUpdate, ExternalReferenceProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the definition of a external reference.- Parameters:
userId
- calling userexternalReferenceGUID
- unique identifier of external referenceisMergeUpdate
- are unspecified properties unchanged (true) or replaced with null?properties
- properties to change- Throws:
InvalidParameterException
- guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not knownPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
deleteExternalReference
void deleteExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the definition of a external reference.- Parameters:
userId
- calling userexternalReferenceGUID
- unique identifier of external reference- Throws:
InvalidParameterException
- guid or userId is null; guid is not knownPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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.
-
getExternalReferenceByGUID
ExternalReferenceElement getExternalReferenceByGUID(java.lang.String userId, java.lang.String externalReferenceGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return information about a specific external reference.- Parameters:
userId
- calling userexternalReferenceGUID
- unique identifier for the external reference- Returns:
- properties of the external reference
- Throws:
InvalidParameterException
- externalReferenceGUID or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
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 entitystartFrom
- 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.
-
findExternalReferencesByURL
java.util.List<ExternalReferenceElement> findExternalReferencesByURL(java.lang.String userId, java.lang.String url, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, 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:
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.
-
-