001/*
002 * (C) Copyright 2018 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 * External entity interface.
024 *
025 * @since 10.3
026 */
027public interface ExternalEntity {
028
029    /**
030     * Gets annotation entity id, generated by the external service.
031     *
032     * @return the entity id
033     */
034    String getEntityId();
035
036    /**
037     * Sets annotation entity id.
038     *
039     * @param entityId the entity id
040     */
041    void setEntityId(String entityId);
042
043    /**
044     * Gets annotation origin.
045     *
046     * @return the origin
047     */
048    String getOrigin();
049
050    /**
051     * Sets annotation origin.
052     *
053     * @param origin the origin
054     */
055    void setOrigin(String origin);
056
057    /**
058     * Gets annotation entity. This represents the annotation model as the rendition server describes it.
059     *
060     * @return the entity
061     */
062    String getEntity();
063
064    /**
065     * Sets annotation entity.
066     *
067     * @param entity the entity
068     */
069    void setEntity(String entity);
070
071}