de.uka.ipd.consensus.foundation.schema
Interface Commentatable

All Superinterfaces:

Serializable

All Known Subinterfaces:

Association, Attribute, Concept, Rating, Topic, User

All Known Implementing Classes:

AssociationImpl, AttributeImpl, SQLRatingImpl, TM4JRatingImpl, TM4JTopicWrapper, TopicImpl, UserImpl

public interface Commentatable

extends Serializable

This is a mixin interface for elements that can have comments.

Version:

2006-06-14

Author:

Thomas Much

Method Summary

String	getComment() Returns the comment of the element.
void	setComment(User setter, String comment) Changes the element's comment.

Method Detail

getComment

public String getComment()

Returns the comment of the element.

Returns:

the comment (may be the empty string, but never null)

setComment

public void setComment(User setter,
                       String comment)
                throws OntologyManagerException,
                       DynamicRightsManagerException

Changes the element's comment.

Parameters:

setter - the user who wants to change the comment

comment - the new comment (null is treated as an empty string)

Throws:

OntologyManagerException - if the comment could not be changed

DynamicRightsManagerException - if the user is not allowed to change the comment

See Also:

DynamicRightsManager.mayChangeConceptComment(User, Concept), DynamicRightsManager.mayChangeUserComment(User, User)