001/*
002 * (C) Copyright 2018-2020 Nuxeo (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 *     Funsho David
018 */
019
020package org.nuxeo.ecm.platform.comment.api;
021
022/**
023 * @since 10.1
024 */
025public class AnnotationConstants {
026
027    private AnnotationConstants() {
028        // utility class
029    }
030
031    // --------------------------------------------
032    // Document type, schema and property constants
033    // --------------------------------------------
034
035    public static final String ANNOTATION_DOC_TYPE = "Annotation";
036
037    /** @since 11.1 */
038    public static final String ANNOTATION_SCHEMA = "annotation";
039
040    public static final String ANNOTATION_XPATH_PROPERTY = "annotation:xpath";
041
042    // -------------------------------------------
043    // Entity type and field name constants (JSON)
044    // -------------------------------------------
045
046    /** @since 11.1 */
047    public static final String ANNOTATION_ENTITY_TYPE = "annotation";
048
049    /** @since 11.1 */
050    public static final String ANNOTATION_XPATH_FIELD = "xpath";
051
052    /** @since 11.1 */
053    public static final String ANNOTATION_PERMISSIONS_FIELD = "permissions";
054
055    /**
056     * @since 10.3
057     * @deprecated since 11.1, use {@link AnnotationConstants#ANNOTATION_XPATH_FIELD} instead
058     */
059    @Deprecated(since = "11.1")
060    public static final String ANNOTATION_XPATH = "xpath";
061
062    /**
063     * @since 10.3
064     * @deprecated since 11.1, use {@link AnnotationConstants#ANNOTATION_PERMISSIONS_FIELD} instead
065     */
066    @Deprecated(since = "11.1")
067    public static final String ANNOTATION_PERMISSIONS = "permissions";
068
069}