Interface AuthorReviewerNameController

All Known Subinterfaces:
AuthorReviewController, ReviewController

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorReviewerNameController
Provides access to reviewer author name, used in the processing instruction that results when a tracked change or a comment is serialized.
Since:
15.1
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the current reviewer author name.
    void
    Set the current reviewer author name, used in the processing instruction that results when a
    Tracked Change
    (<?oxy_insert_start author="reviewer_name"...?>xml content<?oxy_insert_end?>)
    or
    Comment
    (<?oxy_comment_start author="reviewer_name"...?>xml content<?oxy_comment_end?>)
    is serialized, as value of the "author" attribute.
  • Method Details

    • setReviewerAuthorName

      void setReviewerAuthorName(String authorName)
      Set the current reviewer author name, used in the processing instruction that results when a
      Tracked Change
      (<?oxy_insert_start author="reviewer_name"...?>xml content<?oxy_insert_end?>)
      or
      Comment
      (<?oxy_comment_start author="reviewer_name"...?>xml content<?oxy_comment_end?>)
      is serialized, as value of the "author" attribute. By default the author name specified in the Oxygen Preferences is used for serialization.
      Parameters:
      authorName - The reviewer author name. If set to null, the default author name (as set in the Oxygen Preferences) will be used in Change Tracking and Comments serialization.
    • getReviewerAuthorName

      String getReviewerAuthorName()
      Get the current reviewer author name.
      By default, the reviewer author name is the author name specified in the Oxygen Preferences but it can be changed by using setReviewerAuthorName(String).
      Returns:
      The current reviewer author name.