org.nuxeo.ecm.platform.routing.core.impl

Class DocumentRoutingTreePersister

java.lang.Object

org.nuxeo.ecm.platform.routing.core.impl.DocumentRoutingTreePersister

All Implemented Interfaces:

DocumentRoutingPersister

Direct Known Subclasses:

CaseManagementDocRoutingTreePersister

public class DocumentRoutingTreePersister
extends Object
implements DocumentRoutingPersister

The default persister. It persists the DocumentRoute in a tree hierarchy ressembling the current date. New model created from instance are stored in the personal workspace of the user.

Author:

arussel

Field Summary

Fields inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister

DocumentRouteInstanceRootName

Constructor Summary

Constructors

Constructor and Description
DocumentRoutingTreePersister()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	createDocumentRouteInstanceFromDocumentRouteModel(DocumentModel model, CoreSession session) Creates a blank DocumentRoute instance from a model.
String	getNewModelName(DocumentModel instance) Return the new name of a model when it is created from an instance.
DocumentModel	getOrCreateRootOfDocumentRouteInstanceStructure(CoreSession session) Will get, and create if it does not exists the root document in which DocumentRoute structure will be created.
DocumentModel	getParentFolderForDocumentRouteInstance(DocumentModel document, CoreSession session) Get or create the parent folder for a DocumentRoute route instance.
DocumentModel	getParentFolderForNewModel(CoreSession session, DocumentModel instance) Returns a folder in which new model, created from an instance of route will be stored.
DocumentModel	saveDocumentRouteInstanceAsNewModel(DocumentModel routeInstance, DocumentModel parentFolder, CoreSession session)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentRoutingTreePersister

public DocumentRoutingTreePersister()

Method Detail

getParentFolderForDocumentRouteInstance

public DocumentModel getParentFolderForDocumentRouteInstance(DocumentModel document,
                                                    CoreSession session)

Description copied from interface: DocumentRoutingPersister

Get or create the parent folder for a DocumentRoute route instance.

Specified by:

getParentFolderForDocumentRouteInstance in interface DocumentRoutingPersister

Parameters:

document - The DocumentRoute model from which the instance will be created. Its metadata may be used when creating the parent.

Returns:

The parent folder in which the DocumentRoute will be persisted.

createDocumentRouteInstanceFromDocumentRouteModel

public DocumentModel createDocumentRouteInstanceFromDocumentRouteModel(DocumentModel model,
                                                              CoreSession session)

Description copied from interface: DocumentRoutingPersister

Creates a blank DocumentRoute instance from a model.

Specified by:

createDocumentRouteInstanceFromDocumentRouteModel in interface DocumentRoutingPersister

Parameters:

model - the model

Returns:

The created DocumentRoute

saveDocumentRouteInstanceAsNewModel

public DocumentModel saveDocumentRouteInstanceAsNewModel(DocumentModel routeInstance,
                                                DocumentModel parentFolder,
                                                CoreSession session)

Specified by:

saveDocumentRouteInstanceAsNewModel in interface DocumentRoutingPersister

Returns:

getOrCreateRootOfDocumentRouteInstanceStructure

public DocumentModel getOrCreateRootOfDocumentRouteInstanceStructure(CoreSession session)

Description copied from interface: DocumentRoutingPersister

Will get, and create if it does not exists the root document in which DocumentRoute structure will be created.

Specified by:

getOrCreateRootOfDocumentRouteInstanceStructure in interface DocumentRoutingPersister

Parameters:

session - The session use to get or create the document.

Returns:

The root of the DocumentRoute structure.

getParentFolderForNewModel

public DocumentModel getParentFolderForNewModel(CoreSession session,
                                       DocumentModel instance)

Description copied from interface: DocumentRoutingPersister

Returns a folder in which new model, created from an instance of route will be stored.

Specified by:

getParentFolderForNewModel in interface DocumentRoutingPersister

Parameters:

session - the session of the user

instance - the instance that will be persisted as new model.

getNewModelName

public String getNewModelName(DocumentModel instance)

Description copied from interface: DocumentRoutingPersister

Return the new name of a model when it is created from an instance.

Specified by:

getNewModelName in interface DocumentRoutingPersister

Returns:

the new name

See Also:

DocumentRoutingService#saveRouteAsNewModel(DocumentRoute, String, CoreSession)