org.ametys.plugins.repository.metadata

Interface CommentableCompositeMetadata

All Superinterfaces:

CompositeMetadata

All Known Implementing Classes:

JCRCompositeMetadata

public interface CommentableCompositeMetadata
extends CompositeMetadata

Commentable CompositeMetadata.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.repository.metadata.CompositeMetadata

CompositeMetadata.MetadataType

Method Summary

Modifier and Type	Method and Description
void	addComment(String metadataName, String text, String author, Date date) Add a metadata comment.
void	deleteComment(String metadataName, int index) Delete a metadata comment.
void	editComment(String metadataName, int index, String text, String author, Date date) Edit the text of a metadata comment.
List<MetadataComment>	getComments(String metadataName) Retrieves the comments of a metadata
boolean	hasComment(String metadataName, int index) Indicates if a metadata has a comment
boolean	hasComments(String metadataName) Indicates if a metadata has any comments

Methods inherited from interface org.ametys.plugins.repository.metadata.CompositeMetadata

copyTo, getBinaryMetadata, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getCompositeMetadata, getDate, getDate, getDateArray, getDateArray, getDouble, getDouble, getDoubleArray, getDoubleArray, getLocalizedString, getLocalizedString, getLong, getLong, getLongArray, getLongArray, getMetadataNames, getMultilingualString, getObjectCollection, getRichText, getString, getString, getStringArray, getStringArray, getType, getUser, getUser, getUserArray, getUserArray, hasMetadata, isMultiple

Method Detail

getComments

List<MetadataComment> getComments(String metadataName)

Retrieves the comments of a metadata

Parameters:

metadataName - The metadata name

Returns:

the list of MetadataComment

hasComments

boolean hasComments(String metadataName)

Indicates if a metadata has any comments

Parameters:

metadataName - The metadata name

Returns:

true if at least one comment exists for this metadata

hasComment

boolean hasComment(String metadataName,
                   int index)

Indicates if a metadata has a comment

Parameters:

metadataName - The metadata name

index - The comment index

Returns:

true if a comment at this index exists for this metadata

addComment

void addComment(String metadataName,
                String text,
                String author,
                Date date)

Add a metadata comment.

Parameters:

metadataName - The metadata name

text - The text of the comment

author - The comment author

date - The date of the comment (null to use the current date)

editComment

void editComment(String metadataName,
                 int index,
                 String text,
                 String author,
                 Date date)

Edit the text of a metadata comment.

Parameters:

metadataName - The metadata name

index - The comment index

text - The new text for the comment

author - The comment author

date - The date of the comment (null to use the current date)

deleteComment

void deleteComment(String metadataName,
                   int index)

Delete a metadata comment.

Parameters:

metadataName - The metadata name

index - The comment index