Package com.flowable.core.service.form

Interface ScopedFormProvider

All Known Implementing Classes:

ScopedFormProviderImpl

public interface ScopedFormProvider

A global intern service that can be used to retrieve the form info for different scope types.

Author:

Filip Hrisafov

See Also:

FormProvider

Method Summary

Modifier and Type	Method	Description
FormInfo	getFormInfoForScope(String scopeType, String scopeId, FormProviderContext context)	Retrieve the form info for the given scopeId in the provided context and scopeType.
FormInfo	getFormInfoForScopeDefinition(String scopeType, String scopeDefinitionId, FormProviderContext context)	Retrieve the form info for the given scopeDefinitionId in the provided context and scopeType.

Method Detail

getFormInfoForScope

FormInfo getFormInfoForScope(String scopeType,
                             String scopeId,
                             FormProviderContext context)

Retrieve the form info for the given scopeId in the provided context and scopeType.

Parameters:

scopeType - the scope type

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

getFormInfoForScopeDefinition

FormInfo getFormInfoForScopeDefinition(String scopeType,
                                       String scopeDefinitionId,
                                       FormProviderContext context)

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

Parameters:

scopeType - the scope type

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