org.flowable.form.engine.impl

Class FormRepositoryServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<FormEngineConfiguration>

org.flowable.form.engine.impl.FormRepositoryServiceImpl

All Implemented Interfaces:

FormRepositoryService

public class FormRepositoryServiceImpl
extends CommonEngineServiceImpl<FormEngineConfiguration>
implements FormRepositoryService

Author:

Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
FormRepositoryServiceImpl(FormEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
void	changeDeploymentParentDeploymentId(String deploymentId, String newParentDeploymentId) Changes the parent deployment id of a deployment.
FormDeploymentBuilder	createDeployment()
FormDeploymentQuery	createDeploymentQuery()
FormDefinitionQuery	createFormDefinitionQuery()
NativeFormDeploymentQuery	createNativeDeploymentQuery()
NativeFormDefinitionQuery	createNativeFormDefinitionQuery()
void	deleteDeployment(String deploymentId) Deletes the given deployment.
void	deleteDeployment(String deploymentId, boolean cascade) Deletes the given deployment and cascade deletion to form instances
FormDeployment	deploy(FormDeploymentBuilderImpl deploymentBuilder)
List<String>	getDeploymentResourceNames(String deploymentId)
FormDefinition	getFormDefinition(String formDefinitionId)
InputStream	getFormDefinitionResource(String formId)
FormInfo	getFormModelById(String formId)
FormInfo	getFormModelByKey(String formDefinitionKey)
FormInfo	getFormModelByKey(String formDefinitionKey, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId)
FormInfo	getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String tenantId, boolean fallbackToDefaultTenant)
InputStream	getResourceAsStream(String deploymentId, String resourceName)
void	setDeploymentCategory(String deploymentId, String category) Changes the category of a deployment.
void	setDeploymentTenantId(String deploymentId, String newTenantId) Changes the tenant id of a deployment.
void	setFormDefinitionCategory(String formId, String category)

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

FormRepositoryServiceImpl

public FormRepositoryServiceImpl(FormEngineConfiguration engineConfiguration)

Method Detail

createDeployment

public FormDeploymentBuilder createDeployment()

Specified by:

createDeployment in interface FormRepositoryService

deploy

public FormDeployment deploy(FormDeploymentBuilderImpl deploymentBuilder)

deleteDeployment

public void deleteDeployment(String deploymentId)

Description copied from interface: FormRepositoryService

Deletes the given deployment.

Specified by:

deleteDeployment in interface FormRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeployment

public void deleteDeployment(String deploymentId,
                             boolean cascade)

Description copied from interface: FormRepositoryService

Deletes the given deployment and cascade deletion to form instances

Specified by:

deleteDeployment in interface FormRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

createFormDefinitionQuery

public FormDefinitionQuery createFormDefinitionQuery()

Specified by:

createFormDefinitionQuery in interface FormRepositoryService

createNativeFormDefinitionQuery

public NativeFormDefinitionQuery createNativeFormDefinitionQuery()

Specified by:

createNativeFormDefinitionQuery in interface FormRepositoryService

getDeploymentResourceNames

public List<String> getDeploymentResourceNames(String deploymentId)

Specified by:

getDeploymentResourceNames in interface FormRepositoryService

getResourceAsStream

public InputStream getResourceAsStream(String deploymentId,
                                       String resourceName)

Specified by:

getResourceAsStream in interface FormRepositoryService

setDeploymentCategory

public void setDeploymentCategory(String deploymentId,
                                  String category)

Description copied from interface: FormRepositoryService

Changes the category of a deployment.

Specified by:

setDeploymentCategory in interface FormRepositoryService

Parameters:

deploymentId - The id of the deployment of which the category will be changed.

category - The new category.

setDeploymentTenantId

public void setDeploymentTenantId(String deploymentId,
                                  String newTenantId)

Description copied from interface: FormRepositoryService

Changes the tenant id of a deployment.

Specified by:

setDeploymentTenantId in interface FormRepositoryService

Parameters:

deploymentId - The id of the deployment of which the tenant identifier will be changed.

newTenantId - The new tenant identifier.

changeDeploymentParentDeploymentId

public void changeDeploymentParentDeploymentId(String deploymentId,
                                               String newParentDeploymentId)

Description copied from interface: FormRepositoryService

Changes the parent deployment id of a deployment. This is used to move deployments to a different app deployment parent.

Specified by:

changeDeploymentParentDeploymentId in interface FormRepositoryService

Parameters:

deploymentId - The id of the deployment of which the parent deployment identifier will be changed.

newParentDeploymentId - The new parent deployment identifier.

createDeploymentQuery

public FormDeploymentQuery createDeploymentQuery()

Specified by:

createDeploymentQuery in interface FormRepositoryService

createNativeDeploymentQuery

public NativeFormDeploymentQuery createNativeDeploymentQuery()

Specified by:

createNativeDeploymentQuery in interface FormRepositoryService

getFormDefinition

public FormDefinition getFormDefinition(String formDefinitionId)

Specified by:

getFormDefinition in interface FormRepositoryService

getFormModelById

public FormInfo getFormModelById(String formId)

Specified by:

getFormModelById in interface FormRepositoryService

getFormModelByKey

public FormInfo getFormModelByKey(String formDefinitionKey)

Specified by:

getFormModelByKey in interface FormRepositoryService

getFormModelByKey

public FormInfo getFormModelByKey(String formDefinitionKey,
                                  String tenantId,
                                  boolean fallbackToDefaultTenant)

Specified by:

getFormModelByKey in interface FormRepositoryService

getFormModelByKeyAndParentDeploymentId

public FormInfo getFormModelByKeyAndParentDeploymentId(String formDefinitionKey,
                                                       String parentDeploymentId)

Specified by:

getFormModelByKeyAndParentDeploymentId in interface FormRepositoryService

getFormModelByKeyAndParentDeploymentId

public FormInfo getFormModelByKeyAndParentDeploymentId(String formDefinitionKey,
                                                       String parentDeploymentId,
                                                       String tenantId,
                                                       boolean fallbackToDefaultTenant)

Specified by:

getFormModelByKeyAndParentDeploymentId in interface FormRepositoryService

getFormDefinitionResource

public InputStream getFormDefinitionResource(String formId)

Specified by:

getFormDefinitionResource in interface FormRepositoryService

setFormDefinitionCategory

public void setFormDefinitionCategory(String formId,
                                      String category)

Specified by:

setFormDefinitionCategory in interface FormRepositoryService