Package ro.sync.ecss.extensions.api.highlights

Interface AuthorPersistentHighlightConstants

  • All Known Subinterfaces:
    AuthorPersistentHighlight
    @API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorPersistentHighlightConstants
    Constants used in the serialization process of the Author Persistent Highlights.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTR_NAME_ATTRIBUTE
      The name of the attribute holding the name of the changed attribute.
      static java.lang.String AUTHOR_NAME_ATTRIBUTE
      The pseudo attribute name of the PI holding the name of the author who made the modification.
      static java.lang.String COMMENT_ATTRIBUTE
      The pseudo attribute name of the PI holding the comment of the author who made the modification.
      static java.lang.String COMMENT_ID
      The pseudo attribute name of the PI holding the id of the comment.
      static java.lang.String COMMENT_PARENT_ID
      The pseudo attribute name of the PI holding the parent id.
      static java.lang.String CONTENT_ATTRIBUTE
      The pseudo attribute name (of the delete PI) holding the deleted content.
      static java.lang.String DONE_ATTRIBUTE_VALUE
      One of the values for FLAG_ATTRIBUTE.
      static java.lang.String EMPTY_MARKER_ATTRIBUTE
      The name of the attribute that specifies that a marker is not over any content...
      static java.lang.String FLAG_ATTRIBUTE
      The pseudo attribute name of the PI holding the flag of the marker.
      static java.lang.String MID_ATTRIBUTE
      The name of the id attribute which identifies start and end PI markers when they overlap.
      static java.lang.String MODIFICATION_TIME
      The pseudo attribute name of the PI holding the modification time.
      static java.lang.String TYPE_ATTRIBUTE
      The name of the attribute holding the type of the change.

    • Field Detail

      • AUTHOR_NAME_ATTRIBUTE

        static final java.lang.String AUTHOR_NAME_ATTRIBUTE
        The pseudo attribute name of the PI holding the name of the author who made the modification.
        The value is author.
        See Also:
        Constant Field Values

      • COMMENT_ATTRIBUTE

        static final java.lang.String COMMENT_ATTRIBUTE
        The pseudo attribute name of the PI holding the comment of the author who made the modification.
        The value is comment.
        See Also:
        Constant Field Values

      • MODIFICATION_TIME

        static final java.lang.String MODIFICATION_TIME
        The pseudo attribute name of the PI holding the modification time.
        The value is timestamp.
        See Also:
        Constant Field Values

      • COMMENT_ID

        static final java.lang.String COMMENT_ID
        The pseudo attribute name of the PI holding the id of the comment. This is first set when a reply is added to the highlight, and will be used as parent id for all its replies.
        The value is id.
        See Also:
        Constant Field Values

      • COMMENT_PARENT_ID

        static final java.lang.String COMMENT_PARENT_ID
        The pseudo attribute name of the PI holding the parent id.
        The parent ID is set on a comment that is a reply to another highlight. Its value is the same as the value of the parent's COMMENT_ID property value.
        The value is parentID.
        See Also:
        Constant Field Values

      • FLAG_ATTRIBUTE

        static final java.lang.String FLAG_ATTRIBUTE
        The pseudo attribute name of the PI holding the flag of the marker. Can have multiple values.
        One of the values can be "done"
        See Also:
        Constant Field Values

      • CONTENT_ATTRIBUTE

        static final java.lang.String CONTENT_ATTRIBUTE
        The pseudo attribute name (of the delete PI) holding the deleted content.
        The value is content.
        See Also:
        Constant Field Values

      • MID_ATTRIBUTE

        static final java.lang.String MID_ATTRIBUTE
        The name of the id attribute which identifies start and end PI markers when they overlap.
        See Also:
        Constant Field Values

      • EMPTY_MARKER_ATTRIBUTE

        static final java.lang.String EMPTY_MARKER_ATTRIBUTE
        The name of the attribute that specifies that a marker is not over any content...
        See Also:
        Constant Field Values

      • TYPE_ATTRIBUTE

        static final java.lang.String TYPE_ATTRIBUTE
        The name of the attribute holding the type of the change.
        See Also:
        Constant Field Values

      • ATTR_NAME_ATTRIBUTE

        static final java.lang.String ATTR_NAME_ATTRIBUTE
        The name of the attribute holding the name of the changed attribute.
        See Also:
        Constant Field Values