org.ametys.plugins.repository.data.repositorydata

Interface ModifiableCommentableRepositoryData

All Superinterfaces:

CommentableRepositoryData, RepositoryData

All Known Implementing Classes:

JCRRepositoryData

public interface ModifiableCommentableRepositoryData
extends CommentableRepositoryData

Interface for modifiable commentable data values management in repository

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.repositorydata.RepositoryData

BOOLEAN_REPOSITORY_DATA_TYPE, CALENDAR_REPOSITORY_DATA_TYPE, DOUBLE_REPOSITORY_DATA_TYPE, LONG_REPOSITORY_DATA_TYPE, STREAM_REPOSITORY_DATA_TYPE, STRING_REPOSITORY_DATA_TYPE

Method Summary

Modifier and Type	Method and Description
void	addComment(String name, String text, String author, Date date) Add a comment on the data stored in the repository with the given name
void	deleteComment(String name, int index) Delete a comment on the data stored in the repository with the given name
void	editComment(String name, int index, String text, String author, Date date) Edit the text of a comment on the data stored in the repository with the given name

Methods inherited from interface org.ametys.plugins.repository.data.repositorydata.CommentableRepositoryData

getComments, hasComment, hasComments

Methods inherited from interface org.ametys.plugins.repository.data.repositorydata.RepositoryData

getAllDataNames, getBoolean, getBoolean, getBooleans, getBooleans, getDataNames, getDataNames, getDate, getDate, getDates, getDates, getDefaultPrefix, getDouble, getDouble, getDoubles, getDoubles, getFullName, getLong, getLong, getLongs, getLongs, getName, getPath, getRepositoryData, getRepositoryData, getStream, getStream, getStreamLength, getStreamLength, getStreams, getStreams, getString, getString, getStrings, getStrings, getType, getType, hasValue, hasValue, isMultiple, isMultiple

Method Detail

addComment

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

Add a comment on the data stored in the repository with the given name

Parameters:

name - name of the data

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 name,
                 int index,
                 String text,
                 String author,
                 Date date)

Edit the text of a comment on the data stored in the repository with the given name

Parameters:

name - name of the data

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 name,
                   int index)

Delete a comment on the data stored in the repository with the given name

Parameters:

name - name of the data

index - the comment index