Package com.yworkflow.instance.extension

Interface WorkflowInstanceAttributeRegister<T>

Type Parameters:

T - the type of attribute data to register

All Superinterfaces:

WorkflowInstanceExtension

public interface WorkflowInstanceAttributeRegister<T>
extends WorkflowInstanceExtension

Interface for implementing custom workflow instance attribute registers. WorkflowInstanceAttributeRegister provides a way to load and register transient attributes during workflow instance execution, with access to the workflow instance context and register configuration.

Since:

1.0

See Also:

• WorkflowInstanceExtension
• WorkflowExecutionContext
• Register

Method Summary

Modifier and Type	Method	Description
default WorkflowInstanceAttributeRegister<T>	createVariant(String variant)	Functions can be registered using wildcard, allowing to create a specific version at runtime.
T	registerAttribute(WorkflowExecutionContext context, Register register, Attributes args)	Registers attributes for the workflow instance based on the register configuration.

Methods inherited from interface com.yworkflow.instance.extension.WorkflowInstanceExtension

getPriority, getRegistration

Method Details

registerAttribute

T registerAttribute(WorkflowExecutionContext context,
 Register register,
 Attributes args)
             throws WorkflowException

Registers attributes for the workflow instance based on the register configuration.

Parameters:

context - the workflow instance context

register - the register configuration

args - attribute register arguments

Returns:

the registered attribute data

Throws:

WorkflowException - if there's an error registering the attributes

createVariant

default WorkflowInstanceAttributeRegister<T> createVariant(String variant)

Functions can be registered using wildcard, allowing to create a specific version at runtime. For example the script function can receive the script language as a variant and a language specific script function is returned via this function.

Parameters:

variant - name of the variant

Returns:

the variant of the function