Package com.flowable.core.service.form

Interface FormProvider

public interface FormProvider

A flowable internal API used for easier access to form definitions for different scopes.

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
FormInfo	getFormInfoForScopeDefinitionId(String scopeDefinitionId, FormProviderContext context)	Retrieve the form info for the given scopeDefinitionId in the provided context.
FormInfo	getFormInfoForScopeId(String scopeId, FormProviderContext context)	Retrieve the form info for the given scopeId in the provided context
String	getScopeType()	The scope type that this form provider is responsible for

Method Detail

getScopeType

String getScopeType()

The scope type that this form provider is responsible for

getFormInfoForScopeId

FormInfo getFormInfoForScopeId(String scopeId,
                               FormProviderContext context)

Retrieve the form info for the given scopeId in the provided context

Parameters:

scopeId - the scope instance id

context - the context under which the form info should be retrieved (never null)

Returns:

the form info for the scope

getFormInfoForScopeDefinitionId

FormInfo getFormInfoForScopeDefinitionId(String scopeDefinitionId,
                                         FormProviderContext context)

Retrieve the form info for the given scopeDefinitionId in the provided context. This is different compared with getFormInfoForScopeId(String, FormProviderContext) such that it looks for a form for a given definition instead of an instance.

Parameters:

scopeDefinitionId - the scope definition id

context - the context under which the form info should be retrieved (never null)

Returns:

the form info for the scope definition