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.3
024 */
025public class ExternalEntityConstants {
026
027    private ExternalEntityConstants() {
028        // utility class
029    }
030
031    // -------------------------------------------
032    // Entity type and field name constants (JSON)
033    // -------------------------------------------
034
035    public static final String EXTERNAL_ENTITY = "entity";
036
037    /** @since 11.1 */
038    public static final String EXTERNAL_ENTITY_ID_FIELD = "entityId";
039
040    /** @since 11.1 */
041    public static final String EXTERNAL_ENTITY_ORIGIN_FIELD = "origin";
042
043    /**
044     * @deprecated since 11.1, use {@link ExternalEntityConstants#EXTERNAL_ENTITY_ID_FIELD} instead
045     */
046    @Deprecated(since = "11.1")
047    public static final String EXTERNAL_ENTITY_ID = EXTERNAL_ENTITY_ID_FIELD;
048
049    /**
050     * @deprecated since 11.1, use {@link ExternalEntityConstants#EXTERNAL_ENTITY_ORIGIN_FIELD} instead
051     */
052    @Deprecated(since = "11.1")
053    public static final String EXTERNAL_ENTITY_ORIGIN = EXTERNAL_ENTITY_ORIGIN_FIELD;
054
055    // --------------------------------------------
056    // Document type, schema and property constants
057    // --------------------------------------------
058
059    public static final String EXTERNAL_ENTITY_PROPERTY = "externalEntity:entity";
060
061    public static final String EXTERNAL_ENTITY_ID_PROPERTY = "externalEntity:entityId";
062
063    public static final String EXTERNAL_ENTITY_ORIGIN_PROPERTY = "externalEntity:origin";
064
065    public static final String EXTERNAL_ENTITY_FACET = "ExternalEntity";
066
067}