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 *     Nuxeo - initial API and implementation
011 *
012 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
013 */
014
015package org.nuxeo.ecm.core.api.event;
016
017/**
018 * TODO: write description.
019 *
020 * @author DM
021 */
022// TODO a better id-zation is to define concrete instances of a "EventType"
023// class, so the id-s won't be checked against ordinar strings. This has to be
024// redefined in CoreEvent API
025// TODO ...or use enums...
026public final class DocumentEventTypes {
027
028    public static final String ABOUT_TO_CREATE = "aboutToCreate";
029
030    /**
031     * Empty document mode created by the DocumentModelFactory.
032     * <p>
033     * Useful for initialization of the fields with computed contextual data.
034     */
035    public static final String EMPTY_DOCUMENTMODEL_CREATED = "emptyDocumentModelCreated";
036
037    /**
038     * At this point the document is filled with data from DocumentModel.
039     */
040    public static final String DOCUMENT_CREATED = "documentCreated";
041
042    /** @since 5.8 **/
043    public static final String ABOUT_TO_IMPORT = "aboutToImport";
044
045    public static final String DOCUMENT_IMPORTED = "documentImported";
046
047    public static final String ABOUT_TO_REMOVE = "aboutToRemove";
048
049    public static final String DOCUMENT_REMOVED = "documentRemoved";
050
051    public static final String ABOUT_TO_REMOVE_VERSION = "aboutToRemoveVersion";
052
053    public static final String VERSION_REMOVED = "versionRemoved";
054
055    public static final String BEFORE_DOC_UPDATE = "beforeDocumentModification";
056
057    public static final String BEFORE_DOC_SECU_UPDATE = "beforeDocumentSecurityModification";
058
059    public static final String DOCUMENT_UPDATED = "documentModified";
060
061    public static final String DOCUMENT_SECURITY_UPDATED = "documentSecurityUpdated";
062
063    public static final String DOCUMENT_LOCKED = "documentLocked";
064
065    public static final String DOCUMENT_UNLOCKED = "documentUnlocked";
066
067    public static final String ABOUT_TO_COPY = "aboutToCopy";
068
069    public static final String DOCUMENT_CREATED_BY_COPY = "documentCreatedByCopy";
070
071    public static final String DOCUMENT_DUPLICATED = "documentDuplicated";
072
073    public static final String ABOUT_TO_MOVE = "aboutToMove";
074
075    public static final String DOCUMENT_MOVED = "documentMoved";
076
077    public static final String DOCUMENT_PUBLISHED = "documentPublished";
078
079    public static final String DOCUMENT_PROXY_PUBLISHED = "documentProxyPublished";
080
081    public static final String DOCUMENT_PROXY_UPDATED = "documentProxyUpdated";
082
083    public static final String SECTION_CONTENT_PUBLISHED = "sectionContentPublished";
084
085    public static final String BEFORE_DOC_RESTORE = "beforeRestoringDocument";
086
087    public static final String DOCUMENT_RESTORED = "documentRestored";
088
089    public static final String SESSION_SAVED = "sessionSaved";
090
091    public static final String DOCUMENT_CHILDREN_ORDER_CHANGED = "childrenOrderChanged";
092
093    /** This event is too general and should be used with care. */
094    public static final String ABOUT_TO_CHECKOUT = "aboutToCheckout";
095
096    /**
097     * Document checked out. Listeners can increment version numbers. Listeners will be passed a pristine DocumentModel
098     * where changes will not be seen by the main DocumentModel being saved.
099     */
100    public static final String DOCUMENT_CHECKEDOUT = "documentCheckedOut";
101
102    /**
103     * Listeners can increment version numbers. Listeners will be passed a pristine DocumentModel where changes will not
104     * be seen by the main DocumentModel being saved.
105     */
106    public static final String INCREMENT_BEFORE_UPDATE = "incrementBeforeUpdate";
107
108    /** This event is too general and should be used with care. */
109    public static final String ABOUT_TO_CHECKIN = "aboutToCheckIn";
110
111    /** This event is too general and should be used with care. */
112    public static final String DOCUMENT_CHECKEDIN = "documentCheckedIn";
113
114    public static final String SUBSCRIPTION_ASSIGNED = "subscriptionAssigned";
115
116    public static final String EMAIL_DOCUMENT_SEND = "emailDocumentSend";
117
118    /**
119     * Event triggered when a personal user workspace is created
120     *
121     * @since 5.7
122     */
123    public static final String USER_WORKSPACE_CREATED = "userWorkspaceCreated";
124
125    /**
126     * A binary fulltext field has been updated.
127     *
128     * @since 5.9.3
129     */
130    public static final String BINARYTEXT_UPDATED = "binaryTextUpdated";
131
132    /**
133     * @since 6.0
134     */
135    public static final String DOCUMENT_TAG_UPDATED = "documentTagUpdated";
136
137    /**
138     * Event triggered when one or more ACE status have been updated.
139     *
140     * @since 7.4
141     */
142    public static final String ACE_STATUS_UPDATED = "ACEStatusUpdated";
143
144    // Constant utility class
145    private DocumentEventTypes() {
146    }
147
148}