TrashService (Nuxeo ECM Projects 10.10 API)

All Known Subinterfaces:

TrashService

All Known Implementing Classes:

AbstractTrashService, BridgeTrashService, LifeCycleTrashService, PropertyTrashService
```
public interface TrashService
```
Service containing the logic about deleting/purging/undeleting a document.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class TrashService.Feature
Features of the implementation of the service.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TrashService.Feature` Features of the implementation of the service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DISABLE_TRASH_RENAMING` Key for `DocumentModel.getContextData(String)` which skips the renaming during trash/untrash mechanism when the value is `Boolean.TRUE`.
`static String`	`DOCUMENT_TRASHED` Event for a document trashed by the user.
`static String`	`DOCUMENT_UNTRASHED` Event for a document untrashed by the user.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`canPurgeOrUntrash(DocumentModel doc, NuxeoPrincipal principal)` Is document purgeable/untrashable?
`boolean`	`canPurgeOrUntrash(List<DocumentModel> docs, NuxeoPrincipal principal)` Are all documents purgeable/undeletable?
`DocumentModel`	`getAboveDocument(DocumentModel doc, NuxeoPrincipal principal)` Gets the first non trashed ancestor.
`DocumentModelList`	`getDocuments(DocumentModel parent)` Get all documents from the trash of the current document.
`boolean`	`hasFeature(TrashService.Feature feature)` Checks if a feature is available.
`boolean`	`isTrashed(CoreSession session, DocumentRef doc)`
`String`	`mangleName(DocumentModel doc)` Mangles the name of a document to avoid collisions with non-trashed documents when it's in the trash.
`void`	`purgeDocuments(CoreSession session, List<DocumentRef> docRefs)` Purges (completely deletes) documents.
`void`	`purgeDocumentsUnder(DocumentModel parent)` Purges (completely deletes) trashed documents under the given parent.
`default void`	`trashDocument(DocumentModel doc)` Moves document to the trash.
`void`	`trashDocuments(List<DocumentModel> docs)` Moves documents to the trash.
`String`	`unmangleName(DocumentModel doc)` Unmangles the name of a document in the trash to find its un-trashed name.
`default void`	`untrashDocument(DocumentModel doc)` Unmoves document from the trash.
`void`	`untrashDocuments(List<DocumentModel> docs)` Unmoves documents from the trash.

- Field Detail
  - DOCUMENT_TRASHED
```
static final String DOCUMENT_TRASHED
```
    Event for a document trashed by the user. Triggers an async listener that trashes its children too.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_UNTRASHED
```
static final String DOCUMENT_UNTRASHED
```
    Event for a document untrashed by the user. Triggers an async listener that untrashes its children too.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - DISABLE_TRASH_RENAMING
```
static final String DISABLE_TRASH_RENAMING
```
    Key for DocumentModel.getContextData(String) which skips the renaming during trash/untrash mechanism when the value is Boolean.TRUE.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isTrashed
```
boolean isTrashed(CoreSession session,
                  DocumentRef doc)
```
    Returns:
    
    whether or not the input DocumentRef is trashed.
    
    Since:
    
    10.1
  - canPurgeOrUntrash
```
boolean canPurgeOrUntrash(List<DocumentModel> docs,
                          NuxeoPrincipal principal)
```
    Are all documents purgeable/undeletable?
    Documents need to be in the trash for this to be true, in addition to the standard permission checks.
    
    Parameters:
    
    docs - the documents
    
    principal - the current user (to check locks)
    
    Returns:
    
    true if the documents are purgeable/undeletable
  - canPurgeOrUntrash
```
default boolean canPurgeOrUntrash(DocumentModel doc,
                                  NuxeoPrincipal principal)
```
    Is document purgeable/untrashable?
    Documents need to be in the trash for this to be true, in addition to the standard permission checks.
    
    Parameters:
    
    doc - the document
    
    principal - the current user (to check locks)
    
    Returns:
    
    true if the documents are purgeable/untrashable
  - getAboveDocument
```
DocumentModel getAboveDocument(DocumentModel doc,
                               NuxeoPrincipal principal)
```
    Gets the first non trashed ancestor.
    This is used to find what safe document to redirect to when deleting one.
    
    Parameters:
    
    doc - the trashed document
    
    principal - the current user
    
    Returns:
    
    the first non trashed ancestor
  - trashDocuments
```
void trashDocuments(List<DocumentModel> docs)
```
    Moves documents to the trash.
    Do nothing if the document current state is trashed.
    Proxies are removed.
    Since 10.3, sublevels are trashed asynchronously using BAF.
    
    Parameters:
    
    docs - the documents to trash
  - trashDocument
```
default void trashDocument(DocumentModel doc)
```
    Moves document to the trash.
    Do nothing if the document current state is trashed.
    Proxies are removed.
    Since 10.3, sublevels are trashed asynchronously using BAF.
    
    Parameters:
    
    doc - the document to trash
    
    Since:
    
    10.1
  - purgeDocuments
```
void purgeDocuments(CoreSession session,
                    List<DocumentRef> docRefs)
```
    Purges (completely deletes) documents.
    
    Parameters:
    
    session - the session
    
    docRefs - the documents to purge
  - purgeDocumentsUnder
```
void purgeDocumentsUnder(DocumentModel parent)
```
    Purges (completely deletes) trashed documents under the given parent.
    
    Parameters:
    
    parent - The parent document of trashed documents.
    
    Since:
    
    10.1
  - untrashDocuments
```
void untrashDocuments(List<DocumentModel> docs)
```
    Unmoves documents from the trash.
    Also fires async events to untrash the children.
    
    Parameters:
    
    docs - the documents to untrash
  - untrashDocument
```
default void untrashDocument(DocumentModel doc)
```
    Unmoves document from the trash.
    Also fires async events to untrash the children.
    
    Parameters:
    
    doc - the document to untrash
    
    Since:
    
    10.1
  - getDocuments
```
DocumentModelList getDocuments(DocumentModel parent)
```
    Get all documents from the trash of the current document.
    
    Parameters:
    
    parent - The parent document of trash document.
    
    Returns:
    
    All documents in the trash of the current document.
    
    Since:
    
    7.1
  - mangleName
```
String mangleName(DocumentModel doc)
```
    Mangles the name of a document to avoid collisions with non-trashed documents when it's in the trash.
    
    Parameters:
    
    doc - the document
    
    Since:
    
    7.3
  - unmangleName
```
String unmangleName(DocumentModel doc)
```
    Unmangles the name of a document in the trash to find its un-trashed name.
    
    Parameters:
    
    doc - the trashed document
    
    Returns:
    
    the unmangled name
    
    Since:
    
    7.3
  - hasFeature
```
boolean hasFeature(TrashService.Feature feature)
```
    Checks if a feature is available.
    
    Since:
    
    10.1

Interface TrashService

Nested Class Summary

Field Summary

Method Summary

Field Detail

DOCUMENT_TRASHED

DOCUMENT_UNTRASHED

DISABLE_TRASH_RENAMING

Method Detail

isTrashed

canPurgeOrUntrash

canPurgeOrUntrash

getAboveDocument

trashDocuments

trashDocument

purgeDocuments

purgeDocumentsUnder

untrashDocuments

untrashDocument

getDocuments

mangleName

unmangleName

hasFeature