java.lang.Object
- org.nuxeo.ecm.core.api.event.DocumentEventTypes

public final class DocumentEventTypes
extends Object

TODO: write description.

Author:: DM

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ABOUT_TO_CHECKIN`	This event is too general and should be used with care.
`static String`	`ABOUT_TO_CHECKOUT`	This event is too general and should be used with care.
`static String`	`ABOUT_TO_COPY`
`static String`	`ABOUT_TO_CREATE`
`static String`	`ABOUT_TO_IMPORT`
`static String`	`ABOUT_TO_MOVE`
`static String`	`ABOUT_TO_REMOVE`
`static String`	`ABOUT_TO_REMOVE_VERSION`
`static String`	`ACE_STATUS_UPDATED`	Event triggered when one or more ACE status have been updated.
`static String`	`AFTER_EXTEND_RETENTION`	Event triggered after a retention has been extended on a document.
`static String`	`AFTER_MAKE_RECORD`	Event triggered when a document has been turned into a record.
`static String`	`AFTER_REMOVE_LEGAL_HOLD`	Event triggered after a legal hold has been removed on a document.
`static String`	`AFTER_SET_LEGAL_HOLD`	Event triggered after a legal hold has been set on a document.
`static String`	`AFTER_SET_RETENTION`	Event triggered after a retention has been set on a document.
`static String`	`AFTER_UNSET_RETENTION`	Event triggered after a retention has been unset on a document.
`static String`	`BEFORE_DOC_RESTORE`
`static String`	`BEFORE_DOC_SECU_UPDATE`
`static String`	`BEFORE_DOC_UPDATE`
`static String`	`BEFORE_EXTEND_RETENTION`	Event triggered when a retention is about to be extended on a document.
`static String`	`BEFORE_MAKE_RECORD`	Event triggered when a document is about to be turned into a record.
`static String`	`BEFORE_REMOVE_LEGAL_HOLD`	Event triggered when a legal hold is about to be removed on a document.
`static String`	`BEFORE_SET_LEGAL_HOLD`	Event triggered when a legal hold is about to be set on a document.
`static String`	`BEFORE_SET_RETENTION`	Event triggered when a retention is about to be set on a document.
`static String`	`BEFORE_UNSET_RETENTION`	Event triggered when a retention is about to be unset on a document.
`static String`	`BINARYTEXT_UPDATED`	A binary fulltext field has been updated.
`static String`	`BLOB_DIGEST_UPDATED`	A blob had its digest updated.
`static String`	`DOCUMENT_CHECKEDIN`	This event is too general and should be used with care.
`static String`	`DOCUMENT_CHECKEDOUT`	Document checked out.
`static String`	`DOCUMENT_CHILDREN_ORDER_CHANGED`
`static String`	`DOCUMENT_CREATED`	At this point the document is filled with data from DocumentModel.
`static String`	`DOCUMENT_CREATED_BY_COPY`
`static String`	`DOCUMENT_DUPLICATED`
`static String`	`DOCUMENT_IMPORTED`
`static String`	`DOCUMENT_LOCKED`
`static String`	`DOCUMENT_MOVED`
`static String`	`DOCUMENT_PROXY_PUBLISHED`
`static String`	`DOCUMENT_PROXY_UPDATED`
`static String`	`DOCUMENT_PUBLISHED`
`static String`	`DOCUMENT_REMOVAL_CANCELED`
`static String`	`DOCUMENT_REMOVED`
`static String`	`DOCUMENT_RESTORED`
`static String`	`DOCUMENT_SECURITY_UPDATED`
`static String`	`DOCUMENT_TAG_UPDATED`
`static String`	`DOCUMENT_UNLOCKED`
`static String`	`DOCUMENT_UPDATED`
`static String`	`EMAIL_DOCUMENT_SEND`
`static String`	`EMPTY_DOCUMENTMODEL_CREATED`	Empty document mode created by the DocumentModelFactory.
`static String`	`INCREMENT_BEFORE_UPDATE`	Listeners can increment version numbers.
`static String`	`INTERNAL_DOCUMENT_DELETED`
`static String`	`PROXY_REMOVED`
`static String`	`RETENTION_ACTIVE_CHANGED`	Deprecated. since 11.1
`static String`	`RETENTION_EXPIRED`	Event triggered (some time) after the retention of a document has expired.
`static String`	`SECTION_CONTENT_PUBLISHED`
`static String`	`SESSION_SAVED`
`static String`	`SUBSCRIPTION_ASSIGNED`
`static String`	`SYSTEM_PROPERTY`	The event property containing the system property updated.
`static String`	`SYSTEM_PROPERTY_VALUE`	The event property containing the value of the system property updated.
`static String`	`USER_WORKSPACE_CREATED`	Event triggered when a personal user workspace is created
`static String`	`VERSION_REMOVED`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ABOUT_TO_CREATE
```
public static final String ABOUT_TO_CREATE
```
    See Also:
    
    Constant Field Values
  - EMPTY_DOCUMENTMODEL_CREATED
```
public static final String EMPTY_DOCUMENTMODEL_CREATED
```
    Empty document mode created by the DocumentModelFactory.
    Useful for initialization of the fields with computed contextual data.
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_CREATED
```
public static final String DOCUMENT_CREATED
```
    At this point the document is filled with data from DocumentModel.
    
    See Also:
    
    Constant Field Values
  - ABOUT_TO_IMPORT
```
public static final String ABOUT_TO_IMPORT
```
    Since:
    
    5.8
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_IMPORTED
```
public static final String DOCUMENT_IMPORTED
```
    See Also:
    
    Constant Field Values
  - ABOUT_TO_REMOVE
```
public static final String ABOUT_TO_REMOVE
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_REMOVED
```
public static final String DOCUMENT_REMOVED
```
    See Also:
    
    Constant Field Values
  - INTERNAL_DOCUMENT_DELETED
```
public static final String INTERNAL_DOCUMENT_DELETED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_REMOVAL_CANCELED
```
public static final String DOCUMENT_REMOVAL_CANCELED
```
    See Also:
    
    Constant Field Values
  - ABOUT_TO_REMOVE_VERSION
```
public static final String ABOUT_TO_REMOVE_VERSION
```
    See Also:
    
    Constant Field Values
  - VERSION_REMOVED
```
public static final String VERSION_REMOVED
```
    See Also:
    
    Constant Field Values
  - PROXY_REMOVED
```
public static final String PROXY_REMOVED
```
    Since:
    
    2023.0
    
    See Also:
    
    Constant Field Values
  - BEFORE_DOC_UPDATE
```
public static final String BEFORE_DOC_UPDATE
```
    See Also:
    
    Constant Field Values
  - BEFORE_DOC_SECU_UPDATE
```
public static final String BEFORE_DOC_SECU_UPDATE
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_UPDATED
```
public static final String DOCUMENT_UPDATED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_SECURITY_UPDATED
```
public static final String DOCUMENT_SECURITY_UPDATED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_LOCKED
```
public static final String DOCUMENT_LOCKED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_UNLOCKED
```
public static final String DOCUMENT_UNLOCKED
```
    See Also:
    
    Constant Field Values
  - ABOUT_TO_COPY
```
public static final String ABOUT_TO_COPY
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_CREATED_BY_COPY
```
public static final String DOCUMENT_CREATED_BY_COPY
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_DUPLICATED
```
public static final String DOCUMENT_DUPLICATED
```
    See Also:
    
    Constant Field Values
  - ABOUT_TO_MOVE
```
public static final String ABOUT_TO_MOVE
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_MOVED
```
public static final String DOCUMENT_MOVED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_PUBLISHED
```
public static final String DOCUMENT_PUBLISHED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_PROXY_PUBLISHED
```
public static final String DOCUMENT_PROXY_PUBLISHED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_PROXY_UPDATED
```
public static final String DOCUMENT_PROXY_UPDATED
```
    See Also:
    
    Constant Field Values
  - SECTION_CONTENT_PUBLISHED
```
public static final String SECTION_CONTENT_PUBLISHED
```
    See Also:
    
    Constant Field Values
  - BEFORE_DOC_RESTORE
```
public static final String BEFORE_DOC_RESTORE
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_RESTORED
```
public static final String DOCUMENT_RESTORED
```
    See Also:
    
    Constant Field Values
  - SESSION_SAVED
```
public static final String SESSION_SAVED
```
    See Also:
    
    Constant Field Values
  - DOCUMENT_CHILDREN_ORDER_CHANGED
```
public static final String DOCUMENT_CHILDREN_ORDER_CHANGED
```
    See Also:
    
    Constant Field Values
  - ABOUT_TO_CHECKOUT
```
public static final String ABOUT_TO_CHECKOUT
```
    This event is too general and should be used with care.
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_CHECKEDOUT
```
public static final String DOCUMENT_CHECKEDOUT
```
    Document checked out. Listeners can increment version numbers. Listeners will be passed a pristine DocumentModel where changes will not be seen by the main DocumentModel being saved.
    
    See Also:
    
    Constant Field Values
  - INCREMENT_BEFORE_UPDATE
```
public static final String INCREMENT_BEFORE_UPDATE
```
    Listeners can increment version numbers. Listeners will be passed a pristine DocumentModel where changes will not be seen by the main DocumentModel being saved.
    
    See Also:
    
    Constant Field Values
  - ABOUT_TO_CHECKIN
```
public static final String ABOUT_TO_CHECKIN
```
    This event is too general and should be used with care.
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_CHECKEDIN
```
public static final String DOCUMENT_CHECKEDIN
```
    This event is too general and should be used with care.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION_ASSIGNED
```
public static final String SUBSCRIPTION_ASSIGNED
```
    See Also:
    
    Constant Field Values
  - EMAIL_DOCUMENT_SEND
```
public static final String EMAIL_DOCUMENT_SEND
```
    See Also:
    
    Constant Field Values
  - USER_WORKSPACE_CREATED
```
public static final String USER_WORKSPACE_CREATED
```
    Event triggered when a personal user workspace is created
    
    Since:
    
    5.7
    
    See Also:
    
    Constant Field Values
  - BINARYTEXT_UPDATED
```
public static final String BINARYTEXT_UPDATED
```
    A binary fulltext field has been updated.
    
    Since:
    
    5.9.3
    
    See Also:
    
    Constant Field Values
  - BLOB_DIGEST_UPDATED
```
public static final String BLOB_DIGEST_UPDATED
```
    A blob had its digest updated.
    
    Since:
    
    11.5
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY
```
public static final String SYSTEM_PROPERTY
```
    The event property containing the system property updated.
    Available for the event BINARYTEXT_UPDATED.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_VALUE
```
public static final String SYSTEM_PROPERTY_VALUE
```
    The event property containing the value of the system property updated.
    Available for the event BINARYTEXT_UPDATED.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_TAG_UPDATED
```
public static final String DOCUMENT_TAG_UPDATED
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - ACE_STATUS_UPDATED
```
public static final String ACE_STATUS_UPDATED
```
    Event triggered when one or more ACE status have been updated.
    
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - BEFORE_MAKE_RECORD
```
public static final String BEFORE_MAKE_RECORD
```
    Event triggered when a document is about to be turned into a record.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - AFTER_MAKE_RECORD
```
public static final String AFTER_MAKE_RECORD
```
    Event triggered when a document has been turned into a record.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - BEFORE_SET_RETENTION
```
public static final String BEFORE_SET_RETENTION
```
    Event triggered when a retention is about to be set on a document.
    The event's options map contains CoreEventConstants.RETAIN_UNTIL (a Calendar object).
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - BEFORE_UNSET_RETENTION
```
public static final String BEFORE_UNSET_RETENTION
```
    Event triggered when a retention is about to be unset on a document.
    
    Since:
    
    2023.1
    
    See Also:
    
    Constant Field Values
  - BEFORE_EXTEND_RETENTION
```
public static final String BEFORE_EXTEND_RETENTION
```
    Event triggered when a retention is about to be extended on a document.
    The event's options map contains CoreEventConstants.RETAIN_UNTIL (a Calendar object).
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - AFTER_SET_RETENTION
```
public static final String AFTER_SET_RETENTION
```
    Event triggered after a retention has been set on a document.
    The event's options map contains CoreEventConstants.RETAIN_UNTIL (a Calendar object).
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - AFTER_UNSET_RETENTION
```
public static final String AFTER_UNSET_RETENTION
```
    Event triggered after a retention has been unset on a document.
    
    Since:
    
    2023.1
    
    See Also:
    
    Constant Field Values
  - AFTER_EXTEND_RETENTION
```
public static final String AFTER_EXTEND_RETENTION
```
    Event triggered after a retention has been extended on a document.
    The event's options map contains CoreEventConstants.RETAIN_UNTIL (a Calendar object).
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - RETENTION_EXPIRED
```
public static final String RETENTION_EXPIRED
```
    Event triggered (some time) after the retention of a document has expired.
    The event's options map contains CoreEventConstants.RETAIN_UNTIL (a Calendar object), which was the previous retention date.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - BEFORE_SET_LEGAL_HOLD
```
public static final String BEFORE_SET_LEGAL_HOLD
```
    Event triggered when a legal hold is about to be set on a document.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - BEFORE_REMOVE_LEGAL_HOLD
```
public static final String BEFORE_REMOVE_LEGAL_HOLD
```
    Event triggered when a legal hold is about to be removed on a document.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - AFTER_SET_LEGAL_HOLD
```
public static final String AFTER_SET_LEGAL_HOLD
```
    Event triggered after a legal hold has been set on a document.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - AFTER_REMOVE_LEGAL_HOLD
```
public static final String AFTER_REMOVE_LEGAL_HOLD
```
    Event triggered after a legal hold has been removed on a document.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - RETENTION_ACTIVE_CHANGED
```
@Deprecated
public static final String RETENTION_ACTIVE_CHANGED
```
    Deprecated.
    since 11.1
    
    Event triggered when the active state of the retention changes.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values

Class DocumentEventTypes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ABOUT_TO_CREATE

EMPTY_DOCUMENTMODEL_CREATED

DOCUMENT_CREATED

ABOUT_TO_IMPORT

DOCUMENT_IMPORTED

ABOUT_TO_REMOVE

DOCUMENT_REMOVED

INTERNAL_DOCUMENT_DELETED

DOCUMENT_REMOVAL_CANCELED

ABOUT_TO_REMOVE_VERSION

VERSION_REMOVED

PROXY_REMOVED

BEFORE_DOC_UPDATE

BEFORE_DOC_SECU_UPDATE

DOCUMENT_UPDATED

DOCUMENT_SECURITY_UPDATED

DOCUMENT_LOCKED

DOCUMENT_UNLOCKED

ABOUT_TO_COPY

DOCUMENT_CREATED_BY_COPY

DOCUMENT_DUPLICATED

ABOUT_TO_MOVE

DOCUMENT_MOVED

DOCUMENT_PUBLISHED

DOCUMENT_PROXY_PUBLISHED

DOCUMENT_PROXY_UPDATED

SECTION_CONTENT_PUBLISHED

BEFORE_DOC_RESTORE

DOCUMENT_RESTORED

SESSION_SAVED

DOCUMENT_CHILDREN_ORDER_CHANGED

ABOUT_TO_CHECKOUT

DOCUMENT_CHECKEDOUT

INCREMENT_BEFORE_UPDATE

ABOUT_TO_CHECKIN

DOCUMENT_CHECKEDIN

SUBSCRIPTION_ASSIGNED

EMAIL_DOCUMENT_SEND

USER_WORKSPACE_CREATED

BINARYTEXT_UPDATED

BLOB_DIGEST_UPDATED

SYSTEM_PROPERTY

SYSTEM_PROPERTY_VALUE

DOCUMENT_TAG_UPDATED

ACE_STATUS_UPDATED

BEFORE_MAKE_RECORD

AFTER_MAKE_RECORD

BEFORE_SET_RETENTION

BEFORE_UNSET_RETENTION

BEFORE_EXTEND_RETENTION

AFTER_SET_RETENTION

AFTER_UNSET_RETENTION

AFTER_EXTEND_RETENTION

RETENTION_EXPIRED

BEFORE_SET_LEGAL_HOLD

BEFORE_REMOVE_LEGAL_HOLD

AFTER_SET_LEGAL_HOLD

AFTER_REMOVE_LEGAL_HOLD

RETENTION_ACTIVE_CHANGED