Package org.odpi.openmetadata.viewservices.feedbackmanager.handler

Class CollaborationManagerHandler

java.lang.Object

org.odpi.openmetadata.viewservices.feedbackmanager.handler.CollaborationManagerHandler

public class CollaborationManagerHandler
extends Object

CollaborationManagerHandler is the handler for managing comments, ratings, likes and tags.

Constructor Summary

Constructors

Constructor	Description
CollaborationManagerHandler(String localServerName, String serverName, String serverPlatformURLRoot, AuditLog auditLog, String accessServiceURLMarker, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	addCommentReply(String userId, String elementGUID, String commentGUID, boolean isPublic, CommentProperties properties)	Adds a comment to the element.
String	addCommentToElement(String userId, String elementGUID, boolean isPublic, CommentProperties properties)	Adds a comment to the element.
void	addLikeToElement(String userId, String elementGUID, boolean isPublic, Date effectiveTime)	Adds a "Like" to the element.
void	addRatingToElement(String userId, String elementGUID, boolean isPublic, RatingProperties properties, Date effectiveTime)	Adds a star rating and optional review text to the element.
void	addTagToElement(String userId, String elementGUID, String tagGUID, boolean isPublic, Date effectiveTime)	Adds a tag (either private of public) to an element.
void	clearAcceptedAnswer(String userId, String questionCommentGUID, String answerCommentGUID, Date effectiveTime)	Unlink a comment that contains an answer to a question posed in another comment.
String	createInformalTag(String userId, TagProperties properties)	Creates a new informal tag and returns the unique identifier for it.
String	createNote(String userId, String noteLogGUID, NoteProperties noteProperties)	Create a new metadata element to represent a note.
String	createNoteLog(String userId, String elementGUID, NoteLogProperties noteLogProperties, boolean isPublic)	Create a new metadata element to represent a note log and attach it to an element (if supplied).
void	deleteTag(String userId, String tagGUID, Date effectiveTime)	Removes a tag from the repository.
List<CommentElement>	findComments(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of comment metadata elements that contain the search string.
List<InformalTagElement>	findMyTags(String userId, String tag, int startFrom, int pageSize, Date effectiveTime)	Return the list of the calling user's private tags containing the supplied string in either the name or description.
List<NoteLogElement>	findNoteLogs(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of note log metadata elements that contain the search string.
List<NoteElement>	findNotes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of note metadata elements that contain the search string.
List<InformalTagElement>	findTags(String userId, String tag, int startFrom, int pageSize, Date effectiveTime)	Return the list of tags containing the supplied string in either the name or description.
List<CommentElement>	getAttachedComments(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Return the comments attached to an element.
List<LikeElement>	getAttachedLikes(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Return the likes attached to an element.
List<RatingElement>	getAttachedRatings(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Return the ratings attached to an element.
List<InformalTagElement>	getAttachedTags(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Return the informal tags attached to an element.
CommentElement	getComment(String userId, String commentGUID, Date effectiveTime)	Return the requested comment.
List<RelatedMetadataElementStub>	getElementsByTag(String userId, String tagGUID, int startFrom, int pageSize, Date effectiveTime)	Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.
NoteElement	getNoteByGUID(String userId, String noteGUID, Date effectiveTime)	Retrieve the note metadata element with the supplied unique identifier.
NoteLogElement	getNoteLogByGUID(String userId, String noteLogGUID, Date effectiveTime)	Retrieve the note log metadata element with the supplied unique identifier.
List<NoteLogElement>	getNoteLogsByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of note log metadata elements with a matching qualified or display name.
List<NoteLogElement>	getNoteLogsForElement(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of note log metadata elements attached to the element.
List<NoteElement>	getNotesForNoteLog(String userId, String noteLogGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of notes associated with a note log.
InformalTagElement	getTag(String userId, String tagGUID, Date effectiveTime)	Return the tag for the supplied unique identifier (guid).
List<InformalTagElement>	getTagsByName(String userId, String tag, int startFrom, int pageSize, Date effectiveTime)	Return the list of tags exactly matching the supplied name.
void	removeComment(String userId, String commentGUID, Date effectiveTime)	Removes a comment added to the element by this user.
void	removeLikeFromElement(String userId, String elementGUID, Date effectiveTime)	Removes a "Like" added to the element by this user.
void	removeNote(String userId, String noteGUID, Date effectiveTime)	Remove the metadata element representing a note.
void	removeNoteLog(String userId, String noteLogGUID, Date effectiveTime)	Remove the metadata element representing a note log.
void	removeRatingFromElement(String userId, String elementGUID, Date effectiveTime)	Removes of a review that was added to the element by this user.
void	removeTagFromElement(String userId, String elementGUID, String tagGUID, Date effectiveTime)	Removes a tag from the element that was added by this user.
void	setupAcceptedAnswer(String userId, String questionCommentGUID, String answerCommentGUID, boolean isPublic, Date effectiveTime)	Link a comment that contains the best answer to a question posed in another comment.
void	updateComment(String userId, String commentGUID, boolean isMergeUpdate, CommentProperties properties, Date effectiveTime)	Update an existing comment.
void	updateCommentVisibility(String userId, String parentGUID, String commentGUID, boolean isPublic, Date effectiveTime)	Update an existing comment's visibility.
void	updateNote(String userId, String noteGUID, boolean isMergeUpdate, NoteProperties noteProperties, Date effectiveTime)	Update the properties of the metadata element representing a note.
void	updateNoteLog(String userId, String noteLogGUID, boolean isMergeUpdate, NoteLogProperties noteLogProperties, Date effectiveTime)	Update the metadata element representing a note log.
void	updateTagDescription(String userId, String tagGUID, String tagDescription, Date effectiveTime)	Updates the description of an existing tag (either private or public).

Methods inherited from class java.lang.Object

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

Constructor Details

CollaborationManagerHandler

public CollaborationManagerHandler(String localServerName,
 String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 String accessServiceURLMarker,
 int maxPageSize)
                            throws 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

accessServiceURLMarker - optional access service URL marker used to identify which back end service to call

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

addRatingToElement

public void addRatingToElement(String userId,
 String elementGUID,
 boolean isPublic,
 RatingProperties properties,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a star rating and optional review text to the element. If the user has already attached a rating then the original one is over-ridden.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element.

isPublic - is this visible to other people

properties - properties of the rating

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeRatingFromElement

public void removeRatingFromElement(String userId,
 String elementGUID,
 Date effectiveTime)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes of a review that was added to the element by this user.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the attached element.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAttachedRatings

public List<RatingElement> getAttachedRatings(String userId,
 String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the ratings attached to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

list of ratings

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

addLikeToElement

public void addLikeToElement(String userId,
 String elementGUID,
 boolean isPublic,
 Date effectiveTime)
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a "Like" to the element.

Parameters:

userId - userId of user making request

elementGUID - unique identifier for the element

isPublic - is this visible to other people

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeLikeFromElement

public void removeLikeFromElement(String userId,
 String elementGUID,
 Date effectiveTime)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes a "Like" added to the element by this user.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the like object.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAttachedLikes

public List<LikeElement> getAttachedLikes(String userId,
 String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the likes attached to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

list of likes

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

addCommentToElement

public String addCommentToElement(String userId,
 String elementGUID,
 boolean isPublic,
 CommentProperties properties)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a comment to the element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element.

isPublic - is this comment visible to other people.

properties - properties of the comment

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addCommentReply

public String addCommentReply(String userId,
 String elementGUID,
 String commentGUID,
 boolean isPublic,
 CommentProperties properties)
                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a comment to the element.

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment to attach to.

elementGUID - unique identifier for the anchor element.

isPublic - is this comment visible to other people.

properties - properties of the comment

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateComment

public void updateComment(String userId,
 String commentGUID,
 boolean isMergeUpdate,
 CommentProperties properties,
 Date effectiveTime)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update an existing comment.

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment to change.

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

properties - properties of the comment

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateCommentVisibility

public void updateCommentVisibility(String userId,
 String parentGUID,
 String commentGUID,
 boolean isPublic,
 Date effectiveTime)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update an existing comment's visibility.

Parameters:

userId - userId of user making request.

parentGUID - unique identifier for the element that the comment is attached to.

commentGUID - unique identifier for the comment to change.

isPublic - is this visible to other people

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

setupAcceptedAnswer

public void setupAcceptedAnswer(String userId,
 String questionCommentGUID,
 String answerCommentGUID,
 boolean isPublic,
 Date effectiveTime)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a comment that contains the best answer to a question posed in another comment.

Parameters:

userId - calling user

questionCommentGUID - unique identifier of the comment containing the question

answerCommentGUID - unique identifier of the comment containing the accepted answer

isPublic - is this visible to other people

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearAcceptedAnswer

public void clearAcceptedAnswer(String userId,
 String questionCommentGUID,
 String answerCommentGUID,
 Date effectiveTime)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unlink a comment that contains an answer to a question posed in another comment.

Parameters:

userId - calling user

questionCommentGUID - unique identifier of the comment containing the question

answerCommentGUID - unique identifier of the comment containing the accepted answer

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeComment

public void removeComment(String userId,
 String commentGUID,
 Date effectiveTime)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes a comment added to the element by this user.

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment object.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

getComment

public CommentElement getComment(String userId,
 String commentGUID,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the requested comment.

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment object.

effectiveTime - effective time

Returns:

comment properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

getAttachedComments

public List<CommentElement> getAttachedComments(String userId,
 String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the comments attached to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

list of comments

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

findComments

public List<CommentElement> findComments(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of comment metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createInformalTag

public String createInformalTag(String userId,
 TagProperties properties)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Creates a new informal tag and returns the unique identifier for it.

Parameters:

userId - userId of user making request.

properties - name of the tag and (optional) description. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic note.

Returns:

GUID for new tag.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateTagDescription

public void updateTagDescription(String userId,
 String tagGUID,
 String tagDescription,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Updates the description of an existing tag (either private or public).

Parameters:

userId - userId of user making request.

tagGUID - unique identifier for the tag.

tagDescription - description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteTag

public void deleteTag(String userId,
 String tagGUID,
 Date effectiveTime)
               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes a tag from the repository. A private tag can be deleted by its creator and all the references are lost; a public tag can be deleted by anyone, but only if it is not attached to any referenceable.

Parameters:

userId - userId of user making request.

tagGUID - unique id for the tag.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getTag

public InformalTagElement getTag(String userId,
 String tagGUID,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the tag for the supplied unique identifier (guid).

Parameters:

userId - userId of the user making the request.

tagGUID - unique identifier of the tag.

effectiveTime - effective time

Returns:

tag

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getTagsByName

public List<InformalTagElement> getTagsByName(String userId,
 String tag,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of tags exactly matching the supplied name.

Parameters:

userId - the name of the calling user.

tag - name of tag.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

tag list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findTags

public List<InformalTagElement> findTags(String userId,
 String tag,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of tags containing the supplied string in either the name or description.

Parameters:

userId - the name of the calling user.

tag - name of tag. This may include wild card characters.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

tag list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findMyTags

public List<InformalTagElement> findMyTags(String userId,
 String tag,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of the calling user's private tags containing the supplied string in either the name or description.

Parameters:

userId - the name of the calling user.

tag - name of tag. This may include wild card characters.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

tag list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addTagToElement

public void addTagToElement(String userId,
 String elementGUID,
 String tagGUID,
 boolean isPublic,
 Date effectiveTime)
                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a tag (either private of public) to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique id for the element.

tagGUID - unique id of the tag.

isPublic - flag indicating whether the attachment of the tag is public or not

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the element properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeTagFromElement

public void removeTagFromElement(String userId,
 String elementGUID,
 String tagGUID,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes a tag from the element that was added by this user.

Parameters:

userId - userId of user making request.

elementGUID - unique id for the element.

tagGUID - unique id for the tag.

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getElementsByTag

public List<RelatedMetadataElementStub> getElementsByTag(String userId,
 String tagGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements. An Element's GUID may appear multiple times in the results if it is tagged multiple times with the requested tag.

Parameters:

userId - the name of the calling user.

tagGUID - unique identifier of tag.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

element guid list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAttachedTags

public List<InformalTagElement> getAttachedTags(String userId,
 String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the informal tags attached to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

effectiveTime - effective time

Returns:

list of tags

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

createNoteLog

public String createNoteLog(String userId,
 String elementGUID,
 NoteLogProperties noteLogProperties,
 boolean isPublic)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a note log and attach it to an element (if supplied). Any supplied element becomes the note log's anchor, causing the note log to be deleted if/when the element is deleted.

Parameters:

userId - calling user

elementGUID - unique identifier of the element where the note log is located

noteLogProperties - properties about the note log to store

isPublic - is this element visible to other people.

Returns:

unique identifier of the new note log

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateNoteLog

public void updateNoteLog(String userId,
 String noteLogGUID,
 boolean isMergeUpdate,
 NoteLogProperties noteLogProperties,
 Date effectiveTime)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a note log.

Parameters:

userId - calling user

noteLogGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

noteLogProperties - new properties for the metadata element

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeNoteLog

public void removeNoteLog(String userId,
 String noteLogGUID,
 Date effectiveTime)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a note log.

Parameters:

userId - calling user

noteLogGUID - unique identifier of the metadata element to remove

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findNoteLogs

public List<NoteLogElement> findNoteLogs(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of note log metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNoteLogsByName

public List<NoteLogElement> getNoteLogsByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of note log metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNoteLogsForElement

public List<NoteLogElement> getNoteLogsForElement(String userId,
 String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of note log metadata elements attached to the element.

Parameters:

userId - calling user

elementGUID - element to start from

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNoteLogByGUID

public NoteLogElement getNoteLogByGUID(String userId,
 String noteLogGUID,
 Date effectiveTime)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the note log metadata element with the supplied unique identifier.

Parameters:

userId - calling user

noteLogGUID - unique identifier of the requested metadata element

effectiveTime - effective time

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createNote

public String createNote(String userId,
 String noteLogGUID,
 NoteProperties noteProperties)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a note.

Parameters:

userId - calling user

noteLogGUID - unique identifier of the element where the note is located

noteProperties - properties for the note

Returns:

unique identifier of the new metadata element for the note

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateNote

public void updateNote(String userId,
 String noteGUID,
 boolean isMergeUpdate,
 NoteProperties noteProperties,
 Date effectiveTime)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of the metadata element representing a note.

Parameters:

userId - calling user

noteGUID - unique identifier of the note to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

noteProperties - new properties for the note

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeNote

public void removeNote(String userId,
 String noteGUID,
 Date effectiveTime)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a note.

Parameters:

userId - calling user

noteGUID - unique identifier of the metadata element to remove

effectiveTime - effective time

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findNotes

public List<NoteElement> findNotes(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of note metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNotesForNoteLog

public List<NoteElement> getNotesForNoteLog(String userId,
 String noteLogGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of notes associated with a note log.

Parameters:

userId - calling user

noteLogGUID - unique identifier of the note log of interest

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time

Returns:

list of associated metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNoteByGUID

public NoteElement getNoteByGUID(String userId,
 String noteGUID,
 Date effectiveTime)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the note metadata element with the supplied unique identifier.

Parameters:

userId - calling user

noteGUID - unique identifier of the requested metadata element

effectiveTime - effective time

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)