001/*
002 * (C) Copyright 2006-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 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.core.api;
020
021/**
022 * Holds life cycle related constants that are generic enough to be available at a core level.
023 *
024 * @author Anahide Tchertchian
025 */
026public interface LifeCycleConstants {
027
028    /**
029     * @since 10.3, use trash service instead
030     */
031    @Deprecated
032    String DELETED_STATE = "deleted";
033
034    /**
035     * @since 10.3, use trash service instead
036     */
037    @Deprecated
038    String DELETE_TRANSITION = "delete";
039
040    /**
041     * @since 10.3, use trash service instead
042     */
043    @Deprecated
044    String UNDELETE_TRANSITION = "undelete";
045
046    /**
047     * Event for a lifecycle transition.
048     */
049    String TRANSITION_EVENT = "lifecycle_transition_event";
050
051    String TRANSTION_EVENT_OPTION_FROM = "from";
052
053    String TRANSTION_EVENT_OPTION_TO = "to";
054
055    String TRANSTION_EVENT_OPTION_TRANSITION = "transition";
056
057    /**
058     * Event for a document undeleted by the user. Triggers an async listener that undeletes its children too.
059     *
060     * @deprecated since 11.1, technical event used by former trash mechanism
061     */
062    @Deprecated(since = "11.1")
063    String DOCUMENT_UNDELETED = "documentUndeleted";
064
065    /**
066     * Key in context map to specify initial lifecycle state on document creation.
067     */
068    String INITIAL_LIFECYCLE_STATE_OPTION_NAME = "initialLifecycleState";
069
070}