001/*
002 * (C) Copyright 2009-2018 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     mcedica
018 *     Nuno Cunha <[email protected]>
019 */
020package org.nuxeo.ecm.platform.comment.workflow.utils;
021
022/**
023 * Utility class used for registering constants.
024 */
025public final class CommentsConstants {
026
027    /*
028     * Constants used for Comments
029     */
030    public static final String PERMISSION_COMMENT = "Comment";
031
032    public static final String PERMISSION_MODERATE = "Moderate";
033
034    public static final String PERMISSION_WRITE = "Write";
035
036    public static final String PERMISSION_MANAGE_EVERYTHING = "Everything";
037
038    public static final String TRANSITION_TO_PUBLISHED_STATE = "moderation_publish";
039
040    public static final String PUBLISHED_STATE = "moderation_published";
041
042    public static final String PENDING_STATE = "moderation_pending";
043
044    public static final String REJECT_STATE = "moderation_reject";
045
046    public static final String MODERATION_PROCESS = "comments_moderation";
047
048    public static final String COMMENT_ID = "commentId";
049
050    public static final String COMMENT_PUBLISHED = "commentPublished";
051
052    public static final String COMMENT_LIFECYCLE = "comment_moderation";
053
054    public static final String ACCEPT_CHAIN_NAME = "acceptComment";
055
056    public static final String REJECT_CHAIN_NAME = "rejectComment";
057
058    public static final String MODERATION_DIRECTIVE_NAME = "moderate";
059
060    /**
061     * Schemas and fields.
062     */
063    public static final String COMMENT_DOC_TYPE = "Comment";
064
065    /** @since 10.3 */
066    public static final String COMMENT_SCHEMA = "comment";
067
068    public static final String COMMENT_CREATION_DATE = "comment:creationDate";
069
070    public static final String COMMENT_AUTHOR = "comment:author";
071
072    public static final String COMMENT_TEXT = "comment:text";
073
074    /** @since 10.3 */
075    public static final String COMMENT_PARENT_ID = "comment:parentId";
076
077    /** @since 10.3 */
078    public static final String COMMENT_MODIFICATION_DATE = "comment:modificationDate";
079
080    /** @since 10.3 */
081    public static final String COMMENT_ANCESTOR_IDS = "comment:ancestorIds";
082
083    // JSON constant part
084
085    /** @since 10.3 */
086    public static final String COMMENT_ENTITY_TYPE = "comment";
087
088    /** @since 10.3 */
089    public static final String COMMENTS_ENTITY_TYPE = "comments";
090
091    /** @since 10.3 */
092    public static final String COMMENT_ID_FIELD = "id";
093
094    /** @since 10.3 */
095    public static final String COMMENT_PARENT_ID_FIELD = "parentId";
096
097    /** @since 10.3 */
098    public static final String COMMENT_ANCESTOR_IDS_FIELD = "ancestorIds";
099
100    /** @since 10.3 */
101    public static final String COMMENT_AUTHOR_FIELD = "author";
102
103    /** @since 10.3 */
104    public static final String COMMENT_TEXT_FIELD = "text";
105
106    /**
107     * Creation Date in ISO-8601 representation.
108     * @since 10.3
109     */
110    public static final String COMMENT_CREATION_DATE_FIELD = "creationDate";
111
112    /**
113     * Modification Date in ISO-8601 representation.
114     * @since 10.3
115     */
116    public static final String COMMENT_MODIFICATION_DATE_FIELD = "modificationDate";
117
118    /**
119     * Number of direct replies.
120     * @since 10.3
121     */
122    public static final String COMMENT_NUMBER_OF_REPLIES = "numberOfReplies";
123
124    /**
125     * Last Reply Date in ISO-8601 representation.
126     * @since 10.3
127     */
128    public static final String COMMENT_LAST_REPLY_DATE = "lastReplyDate";
129
130    /** @since 10.3 */
131    public static final String COMMENT_PERMISSIONS = "permissions";
132
133    private CommentsConstants() {
134    }
135
136}