CoreEventConstants.java

/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nuxeo - initial API and implementation
 *
 * $Id: CoreEventConstants.java 29901 2008-02-05 17:01:22Z ogrisel $
 */

package org.nuxeo.ecm.core.api.event;

/**
 * Core event constants.
 *
 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
 */
public final class CoreEventConstants {

    public static final String DOC_LIFE_CYCLE = "documentLifeCycle";

    /**
     * BBB for NXP-666: change events to manage DocumentModel instances instead
     * of Document instances.
     * <p>
     * Document is passed as an option in event in case old listeners need it
     * and cannot handle the document model.
     */
    //public static final String DOCUMENT = "document";

    /**
     * Path the of the container of the empty document model that is being
     * created.
     */
    public static final String PARENT_PATH = "parentPath";

    public static final String DOCUMENT_MODEL_ID = "documentModelId";

    public static final String REPOSITORY_NAME = "repositoryName";

    public static final String SESSION_ID = "sessionId";

    public static final String OLD_ACP = "oldACP";

    public static final String NEW_ACP = "newACP";

    public static final String REORDERED_CHILD = "reorderedChild";

    public static final String REPLACED_PROXY_IDS = "replacedProxyRefs";

    /**
     * Passed with beforeDocumentModification and documentModified events to
     * hold the state that is about to be / has been overwritten by the
     * saveDocument.
     */
    public static final String PREVIOUS_DOCUMENT_MODEL = "previousDocumentModel";

    /**
     * Passed with aboutToCopy, aboutToMove, documentCreatedbyCopy and documentMoved events to be able to
     * change the destination name
     *
     * @since 5.7
     */
    public static final String DESTINATION_NAME = "destinationName";

    public static final String DESTINATION_REF = "destinationRef";

    public static final String DESTINATION_PATH = "destinationPath";

    public static final String DESTINATION_EXISTS = "destinationExists";

    public static final String SOURCE_REF = "sourceRef";

    /**
     * Passed with documentCreatedbyCopy event to be able to reset the life
     * cycle or not
     *
     * @since 5.7
     */
    public static final String RESET_LIFECYCLE = "resetLifeCycle";

    // Constant utility class
    private CoreEventConstants() {
    }

}