Package org.flowable.cmmn.engine.impl.function

Class IsPlanItemCompletedExpressionFunction

java.lang.Object

org.flowable.cmmn.engine.impl.function.IsPlanItemCompletedExpressionFunction

All Implemented Interfaces:

FlowableFunctionDelegate, FlowableAstFunctionCreator

public class IsPlanItemCompletedExpressionFunction
extends Object
implements FlowableFunctionDelegate, FlowableAstFunctionCreator

This function evaluates a plan item to be completed, which is most likely used on a plan item with a repetition rule to check, whether it has alreday been completed before.

Author:

Micha Kiener

Constructor Summary

Constructors

Constructor	Description
IsPlanItemCompletedExpressionFunction()

Method Summary

Modifier and Type	Method	Description
AstFunction	createFunction(String name, int index, AstParameters parameters, boolean varargs, FlowableExpressionParser parser)	Create an AstFunction based on the provided name, index, parameters.
Method	functionMethod()	Returns the method that is invoked by JUEL.
Collection<String>	getFunctionNames()	The names of the functions that this creator can create.
static boolean	isPlanItemCompleted(Object object)
String	localName()	The name of the method when used in an expression, like the second part of ${prefix:method()}.
String	prefix()	The prefix of the method when used in an expression, like the first part of ${prefix:method()}.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.api.delegate.FlowableFunctionDelegate

localNames, prefixes

Constructor Details

IsPlanItemCompletedExpressionFunction

public IsPlanItemCompletedExpressionFunction()

Method Details

prefix

public String prefix()

Description copied from interface: FlowableFunctionDelegate

The prefix of the method when used in an expression, like the first part of ${prefix:method()}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

prefix in interface FlowableFunctionDelegate

localName

public String localName()

Description copied from interface: FlowableFunctionDelegate

The name of the method when used in an expression, like the second part of ${prefix:method()}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

localName in interface FlowableFunctionDelegate

functionMethod

public Method functionMethod()

Description copied from interface: FlowableFunctionDelegate

Returns the method that is invoked by JUEL.

Specified by:

functionMethod in interface FlowableFunctionDelegate

getFunctionNames

public Collection<String> getFunctionNames()

Description copied from interface: FlowableAstFunctionCreator

The names of the functions that this creator can create.

Specified by:

getFunctionNames in interface FlowableAstFunctionCreator

createFunction

public AstFunction createFunction(String name,
 int index,
 AstParameters parameters,
 boolean varargs,
 FlowableExpressionParser parser)

Description copied from interface: FlowableAstFunctionCreator

Create an AstFunction based on the provided name, index, parameters. Potentially creating new parameters to enhance the function.

Specified by:

createFunction in interface FlowableAstFunctionCreator

Parameters:

name - the name of the function

index - the index

parameters - the parameters for the function

varargs - whether varargs is supported

parser - the parser for potentially creating identifiers

isPlanItemCompleted

public static boolean isPlanItemCompleted(Object object)