com.actionsoft.apps.resource.plugin.profile

类 AtFormulaPluginProfile

java.lang.Object

AbstPluginProfile

com.actionsoft.apps.resource.plugin.profile.AtFormulaPluginProfile

public class AtFormulaPluginProfile
extends AbstPluginProfile

AT公式接口描述对象

另请参阅:

各种插件的总注册接口

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	_FORMENGINE_NEED
static java.lang.String	_NONE_NEED
static java.lang.String	_PROCESS_INST_NEED
static java.lang.String	_TASK_INST_NEED
static java.lang.String	_USERCONTEXT_NEED

构造器概要

构造器

构造器和说明
AtFormulaPluginProfile(java.lang.String clazz)
AtFormulaPluginProfile(java.lang.String groupName, java.lang.String syntax, java.lang.String clazz, java.lang.String title, java.lang.String desc) 构造
AtFormulaPluginProfile(java.lang.String groupName, java.lang.String syntax, java.lang.String clazz, java.lang.String title, java.lang.String desc, java.lang.String contextNeed) 构造

方法概要

限定符和类型	方法和说明
java.lang.String	getContextNeed() 执行该公式需要的核心上下文参数，用于语法校验和排除特定场景下隐藏不支持的公式，见常量说明
java.lang.String	getGroupName() 公式分类
java.lang.String	getId() 获得该公式名，从给定的syntax解析
java.util.List<java.lang.String>	getParams()
java.lang.String	getSyntax() 语法规则，例子@hour(datetime)。
java.lang.String	getTitle() 公式简短标题说明
boolean	isDeprecated() 判断是否弃用的公式
void	setContextNeed(java.lang.String contextNeed) 设置执行该公式需要的核心上下文参数，多个用逗号隔开，用于语法校验和排除特定场景下隐藏不支持的公式，见常量说明
AtFormulaPluginProfile	setDeprecated(boolean deprecated) 设置当前公式是否被弃用，引擎处理，不展示到前端
void	setGroupName(java.lang.String groupName) 设置分类名
void	setSyntax(java.lang.String syntax) 设置语法规则
void	setTitle(java.lang.String title) 设置公式的简短标题说明

从类继承的方法 java.lang.Object

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

字段详细资料

_NONE_NEED

public static java.lang.String _NONE_NEED

_USERCONTEXT_NEED

public static java.lang.String _USERCONTEXT_NEED

_PROCESS_INST_NEED

public static java.lang.String _PROCESS_INST_NEED

_TASK_INST_NEED

public static java.lang.String _TASK_INST_NEED

_FORMENGINE_NEED

public static java.lang.String _FORMENGINE_NEED

构造器详细资料

AtFormulaPluginProfile

public AtFormulaPluginProfile(java.lang.String clazz)

AtFormulaPluginProfile

public AtFormulaPluginProfile(java.lang.String groupName,
                              java.lang.String syntax,
                              java.lang.String clazz,
                              java.lang.String title,
                              java.lang.String desc,
                              java.lang.String contextNeed)

构造

参数:

groupName - 分类

syntax - 语法，例子@hour(datetime)。如某参数必填可加*前缀，例子@dateAdd(*datepart,*number ,*date)

clazz - 类名称，该类必须继承ExpressionAbst

title - 简要说明

desc - 详细说明

contextNeed - 执行该公式需要的核心上下文参数，用于语法校验和排除特定场景下隐藏不支持的公式，见常量说明

另请参阅:

AbstExpression, _NONE_NEED, _FORMENGINE_NEED, _PROCESS_INST_NEED, _TASK_INST_NEED, _USERCONTEXT_NEED

AtFormulaPluginProfile

public AtFormulaPluginProfile(java.lang.String groupName,
                              java.lang.String syntax,
                              java.lang.String clazz,
                              java.lang.String title,
                              java.lang.String desc)

构造

参数:

groupName - 分类

syntax - 语法，例子@hour(datetime)。如某参数必填可加*前缀，例子@dateAdd(*datepart,*number ,*date)

clazz - 类名称，该类必须继承ExpressionAbst

title - 简要说明

desc - 详细说明

另请参阅:

AbstExpression

方法详细资料

getParams

public java.util.List<java.lang.String> getParams()

getContextNeed

public java.lang.String getContextNeed()

执行该公式需要的核心上下文参数，用于语法校验和排除特定场景下隐藏不支持的公式，见常量说明

返回:

如特定要求依赖某参数返回该参数的标识，无依赖限制返回空串

setContextNeed

public void setContextNeed(java.lang.String contextNeed)

设置执行该公式需要的核心上下文参数，多个用逗号隔开，用于语法校验和排除特定场景下隐藏不支持的公式，见常量说明

参数:

contextNeed - 参数标识

另请参阅:

_NONE_NEED, _FORMENGINE_NEED, _PROCESS_INST_NEED, _TASK_INST_NEED, _USERCONTEXT_NEED

getId

public java.lang.String getId()

获得该公式名，从给定的syntax解析

返回:

getGroupName

public java.lang.String getGroupName()

公式分类

返回:

分类名

setGroupName

public void setGroupName(java.lang.String groupName)

设置分类名

参数:

groupName - 分类名

getTitle

public java.lang.String getTitle()

公式简短标题说明

返回:

setTitle

public void setTitle(java.lang.String title)

设置公式的简短标题说明

参数:

title - 标题名

getSyntax

public java.lang.String getSyntax()

语法规则，例子@hour(datetime)。如某参数必填可加*前缀，例子@dateAdd(*datepart,*number ,*date)

返回:

setSyntax

public void setSyntax(java.lang.String syntax)

设置语法规则

参数:

str - 例子@hour(datetime)。如某参数必填可加*前缀，例子@dateAdd(*datepart,*number ,*date)

isDeprecated

public boolean isDeprecated()

判断是否弃用的公式

返回:

setDeprecated

public AtFormulaPluginProfile setDeprecated(boolean deprecated)

设置当前公式是否被弃用，引擎处理，不展示到前端

参数:

deprecated -

返回: