org.ametys.plugins.repository.data.repositorydata

Interface CommentableRepositoryData

All Superinterfaces:

RepositoryData

All Known Subinterfaces:

ModifiableCommentableRepositoryData

All Known Implementing Classes:

JCRRepositoryData

public interface CommentableRepositoryData
extends RepositoryData

Interface for 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
List<DataComment>	getComments(String name) Retrieves the comments of the data stored in the repository with the given name
boolean	hasComment(String name, int index) Indicates if the data stored in the repository with the given name has a comment
boolean	hasComments(String name) Indicates if the data stored in the repository with the given name has any comments

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

getComments

List<DataComment> getComments(String name)

Retrieves the comments of the data stored in the repository with the given name

Parameters:

name - name of the data

Returns:

the list of DataComment

hasComments

boolean hasComments(String name)

Indicates if the data stored in the repository with the given name has any comments

Parameters:

name - name of the data

Returns:

true if at least one comment exists for this data

hasComment

boolean hasComment(String name,
                   int index)

Indicates if the data stored in the repository with the given name has a comment

Parameters:

name - name of the data

index - the comment index

Returns:

true if a comment at this index exists for this data