001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     Anahide Tchertchian
011 */
012package org.nuxeo.ecm.core.api;
013
014/**
015 * Holds life cycle related constants that are generic enough to be available at a core level.
016 *
017 * @author Anahide Tchertchian
018 */
019public interface LifeCycleConstants {
020
021    static final String DELETED_STATE = "deleted";
022
023    static final String DELETE_TRANSITION = "delete";
024
025    static final String UNDELETE_TRANSITION = "undelete";
026
027    /**
028     * Event for a lifecycle transition.
029     */
030    static final String TRANSITION_EVENT = "lifecycle_transition_event";
031
032    static final String TRANSTION_EVENT_OPTION_FROM = "from";
033
034    static final String TRANSTION_EVENT_OPTION_TO = "to";
035
036    static final String TRANSTION_EVENT_OPTION_TRANSITION = "transition";
037
038    /**
039     * Event for a document undeleted by the user. Triggers an async listener that undeletes its children too.
040     */
041    static final String DOCUMENT_UNDELETED = "documentUndeleted";
042
043    /**
044     * Key in context map to specify initial lifecycle state on document creation.
045     */
046    static final String INITIAL_LIFECYCLE_STATE_OPTION_NAME = "initialLifecycleState";
047
048}