Package org.gbif.api.service.registry

Interface CommentService

All Known Subinterfaces:

CollectionEntityService<T>, CollectionService, DatasetService, InstallationService, InstitutionService, NetworkEntityService<T>, NetworkService, NodeService, OrganizationService

public interface CommentService

Service provides a set of operations on Comment.

Method Summary

Modifier and Type	Method	Description
int	addComment(@NotNull UUID targetEntityKey, @NotNull @Valid Comment comment)	Add a new Comment to a target entity.
void	deleteComment(@NotNull UUID targetEntityKey, int commentKey)	Delete an existing Comment from a target entity by comment key.
List<Comment>	listComments(@NotNull UUID targetEntityKey)	List all comments of a target entity.

Method Detail

addComment

int addComment(@NotNull
               @NotNull UUID targetEntityKey,
               @NotNull @Valid
               @NotNull @Valid Comment comment)

Add a new Comment to a target entity.

Parameters:

targetEntityKey - key of target entity

comment - Comment to add

Returns:

key of Comment added

deleteComment

void deleteComment(@NotNull
                   @NotNull UUID targetEntityKey,
                   int commentKey)

Delete an existing Comment from a target entity by comment key.

Parameters:

targetEntityKey - key of target entity

commentKey - Comment key to delete

listComments

List<Comment> listComments(@NotNull
                           @NotNull UUID targetEntityKey)

List all comments of a target entity.

Parameters:

targetEntityKey - key of target entity

Returns:

list of comments that belong to the entity