ro.sync.ecss.extensions.api.webapp.review

Interface ReviewController

All Superinterfaces:

AuthorChangeTrackingController, AuthorReviewerNameController

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface ReviewController
extends AuthorChangeTrackingController, AuthorReviewerNameController

Provides support for marker related actions (accept/reject tracked changes, add/edit comments, edit author name etc.).

Method Summary

Modifier and Type	Method and Description
void	addComment(int startOffset, int endOffset, java.lang.String comment) Adds a comment marker at given offsets.
void	editComment(AuthorPersistentHighlight highlight, java.lang.String newComment) Edits the comment of a marker (comment and tracked change).
java.util.List<AuthorPersistentHighlight>	getAllHighlights()
void	removeComment(AuthorPersistentHighlight highlight) Removes a comment marker.

Methods inherited from interface ro.sync.ecss.extensions.api.AuthorChangeTrackingController

accept, accept, getAttributeChangeHighlights, getChangeHighlights, getChangeHighlights, isTrackingChanges, reject, reject, toggleTrackChanges

Methods inherited from interface ro.sync.ecss.extensions.api.AuthorReviewerNameController

getReviewerAuthorName, setReviewerAuthorName

Method Detail

addComment

void addComment(int startOffset,
                int endOffset,
                java.lang.String comment)

Adds a comment marker at given offsets.

Parameters:

startOffset - The start offset of the marker (inclusive).

endOffset - The end offset of the marker (exclusive).

comment - The comment of the marker.

removeComment

void removeComment(AuthorPersistentHighlight highlight)

Removes a comment marker.

Parameters:

highlight - The comment marker.

editComment

void editComment(AuthorPersistentHighlight highlight,
                 java.lang.String newComment)

Edits the comment of a marker (comment and tracked change).

Parameters:

highlight - The marker.

newComment - The new comment.

getAllHighlights

java.util.List<AuthorPersistentHighlight> getAllHighlights()

Returns:

An array with all highlights.