Package com.logicaldoc.workflow.template

Interface WorkflowPersistenceTemplateDAO

All Superinterfaces:

com.logicaldoc.core.PersistentObjectDAO<WorkflowPersistenceTemplate>

All Known Implementing Classes:

HibernateWorkflowPersistenceTemplateDAO

public interface WorkflowPersistenceTemplateDAO
extends com.logicaldoc.core.PersistentObjectDAO<WorkflowPersistenceTemplate>

DAO for Persistent WorkFlow Templates handling.

Since:

5.0

Author:

Sebastian Wenzky, Matteo Caruso - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE

Method Summary

Modifier and Type	Method	Description
boolean	delete(WorkflowPersistenceTemplate persistenceTemplate)	This method deletes the given persistence workflow template.
boolean	deploy(WorkflowPersistenceTemplate persistenceTemplate)	This method stores the given persistence workflow template
List<WorkflowPersistenceTemplate>	findAllDeployed(Long tenantId)	This method loads all the workflow already deployed
WorkflowPersistenceTemplate	findByName(long tenantId, String name)	This method finds a workflow template by name
WorkflowPersistenceTemplate	load(long tenantId, String name, WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)	This method loads the persistence workflow template with the given name and with the given workflow stage.
WorkflowPersistenceTemplate	load(WorkflowPersistenceTemplate workflowTemplate, WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflowStage)	This method loads the given persistence workflow template with the given workflow stage.
WorkflowPersistenceTemplate	load(Long id, WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)	This method loads the persistence workflow template with the given id and the given workflow stage.
WorkflowPersistenceTemplate	read(File file)	De-serialize a template from a file
boolean	save(WorkflowPersistenceTemplate persistenceTemplate, WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)	This method saves the persistence workflow template with the given workflow stage.

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, initialize, isOracle, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForObject, queryForRowSet, queryForString, store

Method Detail

save

boolean save(WorkflowPersistenceTemplate persistenceTemplate,
             WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)

This method saves the persistence workflow template with the given workflow stage.

Parameters:

persistenceTemplate - The persistence workflow template to be saved

workflow_stage - The workflow stage

Returns:

true if the template has been correctly saved

delete

boolean delete(WorkflowPersistenceTemplate persistenceTemplate)

This method deletes the given persistence workflow template.

Parameters:

persistenceTemplate - The persistence workflow template to be deleted

Returns:

true if the template has been correctly deleted

load

WorkflowPersistenceTemplate load(Long id,
                                 WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)

This method loads the persistence workflow template with the given id and the given workflow stage.

Parameters:

id - The persistence workflow template id

workflow_stage - The workflow stage

Returns:

The persistence workflow template

load

WorkflowPersistenceTemplate load(WorkflowPersistenceTemplate workflowTemplate,
                                 WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflowStage)

This method loads the given persistence workflow template with the given workflow stage.

Parameters:

workflowTemplate - The persistence workflow template

workflowStage - The workflow stage

Returns:

The persistence workflow template instance

load

WorkflowPersistenceTemplate load(long tenantId,
                                 String name,
                                 WorkflowPersistenceTemplateDAO.WORKFLOW_STAGE workflow_stage)

This method loads the persistence workflow template with the given name and with the given workflow stage.

Parameters:

tenantId - The persistence workflow template tenant

name - The persistence workflow template name

workflow_stage - The workflow stage

Returns:

The persistence workflow template

deploy

boolean deploy(WorkflowPersistenceTemplate persistenceTemplate)
        throws com.logicaldoc.core.PersistenceException

This method stores the given persistence workflow template

Parameters:

persistenceTemplate - The persistence workflow template

Returns:

true if the template has been correctly deployed

Throws:

com.logicaldoc.core.PersistenceException - error in the database

findAllDeployed

List<WorkflowPersistenceTemplate> findAllDeployed(Long tenantId)

This method loads all the workflow already deployed

Parameters:

tenantId - optional tenant specification

Returns:

list of persistence workflow template

findByName

WorkflowPersistenceTemplate findByName(long tenantId,
                                       String name)

This method finds a workflow template by name

Parameters:

tenantId - identifier of the tenant

name - name of the workflow template

Returns:

WorkflowPersistenceTemplate with given name

read

WorkflowPersistenceTemplate read(File file)

De-serialize a template from a file

Parameters:

file - the file storing the template

Returns:

object representation of the template