edu.sjtu.infoplus.applicationToolkit

类 InfoPlusService

java.lang.Object

edu.sjtu.infoplus.applicationToolkit.InfoPlusService

public class InfoPlusService
extends Object

构造器概要

构造器

构造器和说明
InfoPlusService()

方法概要

限定符和类型	方法和说明
edu.sjtu.json.Response<Object>	alter(long instanceId, InstanceState state, String data, String reason) 已过时。
edu.sjtu.json.Response<Object>	alterData(long instanceId, String data) 已过时。
edu.sjtu.json.Response<Object>	alterStatus(long instanceId, InstanceState state, String reason) 已过时。
edu.sjtu.json.Response<Object>	compensate(String workflowCode, long instance) 4.5 触发补偿事件
edu.sjtu.json.Response<CodeItem>	createCodeItem(String workflowCode, String codeType, CodeItem codeItem) 9.6 向代码表新增代码项
edu.sjtu.json.Response<Object>	deleteCodeItem(String workflowCode, String codeType, String codeId) 9.6 删除代码表的代码项
edu.sjtu.json.Response<Object>	doAction(String workflowCode, long instance, String step, String action, Map<String,String> nextUsers, String comment) 以系统身份执行一步工作流。
edu.sjtu.json.Response<Object>	doAction(String workflowCode, long instance, String step, String splitPath, String action, Map<String,String> nextUsers, String comment) 以系统身份执行一步工作流。
edu.sjtu.json.Response<App>	getApp(String workflowCode, String version, boolean includeVersions) 4.1 获取app的meta信息（含表单字段、版本）
edu.sjtu.json.Response<App>	getApp(String clientId, String clientSecret, String workflowCode, String version, boolean includeVersions) 4.1 获取app的meta信息（含表单字段、版本）
edu.sjtu.json.Response<CodeItem>	getCodeItems(String workflowCode, String codeType, String codeId) 9.6 获取代码表中的代码项
String	getEngieUrl() 已过时。
String	getEngineUrl()
edu.sjtu.json.Response<Profile>	getUsersInPosition(String workflowCode, String positionCode, String depCode) 6.2 获取岗位中的用户
boolean	isDebug()
edu.sjtu.json.Response<Object>	kill(String workflowCode, long instance, String remark) 4.5 终止流程
edu.sjtu.json.Response<FormTemplate>	listCanDoTemplates(String userId) 已过时。
edu.sjtu.json.Response<Category>	listCategories(String userId) 已过时。
edu.sjtu.json.Response<FormStep>	listFormStepSummaries(String userId, String category, int start, int limit) 已过时。
edu.sjtu.json.Response<FormField>	listWorkflowFields(String workflowCode) 枚举给定工作流的表单字段
edu.sjtu.json.Response<CodeItem>	modifyCodeItem(String workflowCode, String codeType, CodeItem codeItem) 9.6 修改代码表代码项
edu.sjtu.json.Response<Map<String,Object>>	queryFormData(String workflowCode, long instance) 查询指定表单实例数据。
edu.sjtu.json.Response<Post>	queryPost(String workflowCode, String postCode) 5.1 查询岗位详情
edu.sjtu.json.Response<Profile>	queryUsers(String workflowCode, String accounts, String positions) 5.5 获取用户
void	setApplication(InfoPlusApplication application)
void	setDebug(boolean debug)
void	setEngieUrl(String engineUrl) 已过时。
void	setEngineUrl(String engineUrl)
edu.sjtu.json.Response<String>	start(String owner, String nextUser, String businessId, String workflowCode, String initialData) 启动一个表单实例
edu.sjtu.json.Response<String>	start(String owner, String nextUser, String businessId, String entrance, String workflowCode, String initialData) 启动一个表单实例

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

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

构造器详细资料

InfoPlusService

public InfoPlusService()

方法详细资料

getEngieUrl

@Deprecated
public String getEngieUrl()

已过时。

setEngieUrl

@Deprecated
public void setEngieUrl(String engineUrl)

已过时。

getEngineUrl

public String getEngineUrl()

setEngineUrl

public void setEngineUrl(String engineUrl)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

setApplication

public void setApplication(InfoPlusApplication application)

start

public edu.sjtu.json.Response<String> start(String owner,
                                            String nextUser,
                                            String businessId,
                                            String workflowCode,
                                            String initialData)

启动一个表单实例

参数:

owner - 实例的拥有者

nextUser - 第一步办理用户

businessId - 业务系统id

workflowCode - 流程代码

initialData - 表单数据

返回:

包含：1.instanceId, 2.第一步骤的String.valueOf(formStepId), 3.第一步骤的访问Uri

start

public edu.sjtu.json.Response<String> start(String owner,
                                            String nextUser,
                                            String businessId,
                                            String entrance,
                                            String workflowCode,
                                            String initialData)

启动一个表单实例

参数:

owner - 实例的拥有者

nextUser - 第一步办理用户

businessId - 业务系统id

entrance - 入口节点代码

workflowCode - 流程代码

initialData - 表单数据

返回:

包含：1.instanceId, 2.第一步骤的String.valueOf(formStepId), 3.第一步骤的访问Uri

listWorkflowFields

public edu.sjtu.json.Response<FormField> listWorkflowFields(String workflowCode)

枚举给定工作流的表单字段

参数:

workflowCode - 指定工作流代码

返回:

字端列表

listCanDoTemplates

@Deprecated
public edu.sjtu.json.Response<FormTemplate> listCanDoTemplates(String userId)

已过时。

列举当前用户所有可以发起的表单模板

参数:

userId - 用户的jaccount

返回:

标点定义列表

doAction

public edu.sjtu.json.Response<Object> doAction(String workflowCode,
                                               long instance,
                                               String step,
                                               String action,
                                               Map<String,String> nextUsers,
                                               String comment)

以系统身份执行一步工作流。 由step所指定的步骤必须为当前待做步骤，且该步骤必须允许系统执行。

参数:

workflowCode - 要执行的流程code

instance - 要执行的工作流的instance id

step - 要执行的步骤的code

action - 要执行的动作的code

nextUsers - 指定执行后，下一步骤的执行人。Map的key为下一步骤的code，值为执行人。此参数可以为空，表示不指定。

comment - 备注

返回:

执行结果

doAction

public edu.sjtu.json.Response<Object> doAction(String workflowCode,
                                               long instance,
                                               String step,
                                               String splitPath,
                                               String action,
                                               Map<String,String> nextUsers,
                                               String comment)

以系统身份执行一步工作流。 由step所指定的步骤必须为当前待做步骤，且该步骤必须允许系统执行。

参数:

workflowCode - 要执行的流程code

instance - 要执行的工作流的instance id

step - 要执行的步骤的code

splitPath - 要执行的步骤的动态并行的路径序号。对于重复节嵌套情况，如第x节（0下标）中的第y节并行，应该给出路径为："x/y"

action - 要执行的动作的code

nextUsers - 指定执行后，下一步骤的执行人。Map的key为下一步骤的code，值为执行人。此参数可以为空，表示不指定。

comment - 备注

返回:

执行结果

getApp

public edu.sjtu.json.Response<App> getApp(String workflowCode,
                                          String version,
                                          boolean includeVersions)

4.1 获取app的meta信息（含表单字段、版本）

参数:

workflowCode - 流程代码，对应流程应具有sys_app授权

version - 版本号

includeVersions - 是否包括版本信息

返回:

app的meta信息

getApp

public edu.sjtu.json.Response<App> getApp(String clientId,
                                          String clientSecret,
                                          String workflowCode,
                                          String version,
                                          boolean includeVersions)

4.1 获取app的meta信息（含表单字段、版本）

参数:

clientId - clientId

clientSecret - client密钥

workflowCode - 工作流代码

version - 版本号

includeVersions - 是否包括版本信息

返回:

app的meta信息

kill

public edu.sjtu.json.Response<Object> kill(String workflowCode,
                                           long instance,
                                           String remark)

4.5 终止流程

参数:

workflowCode - 流程代码，对应的流程应具有sys_process_edit授权

instance - 流程实例流水号

remark - 终止流程的备注

返回:

事件响应结果

compensate

public edu.sjtu.json.Response<Object> compensate(String workflowCode,
                                                 long instance)

4.5 触发补偿事件

参数:

workflowCode - 流程代码，对应的流程应具有sys_process_edit授权

instance - 流程实例流水号

返回:

事件响应结果

queryPost

public edu.sjtu.json.Response<Post> queryPost(String workflowCode,
                                              String postCode)

5.1 查询岗位详情

参数:

workflowCode - 流程代码，对应的流程应具有sys_triple权

postCode - 岗位代码

返回:

使用该岗位的App信息

listCategories

@Deprecated
public edu.sjtu.json.Response<Category> listCategories(String userId)

已过时。

列举系统文件夹/分类

参数:

userId - 用户

返回:

分类列表

listFormStepSummaries

@Deprecated
public edu.sjtu.json.Response<FormStep> listFormStepSummaries(String userId,
                                                                          String category,
                                                                          int start,
                                                                          int limit)

已过时。

列举对应文件夹中的表单步骤，并按照lastUpdate时间逆序排序。

参数:

userId - 用户

category - 分类

start - 起始行

limit - 分页大小

返回:

步骤列表

queryFormData

public edu.sjtu.json.Response<Map<String,Object>> queryFormData(String workflowCode,
                                                                long instance)

查询指定表单实例数据。

参数:

workflowCode -

instance - 实例流水号

返回:

表单数据

alterStatus

@Deprecated
public edu.sjtu.json.Response<Object> alterStatus(long instanceId,
                                                              InstanceState state,
                                                              String reason)

已过时。

编程的改变工作流实例的状态

参数:

instanceId - 工作流实例Id

state - 工作流状态 Offline: 挂起 Resume: 恢复 Complete: 完成 Terminate: 中止 Null: 不改变状态，仅修改表单数据/变量

reason - 挂起原因

返回:

结果

alterData

@Deprecated
public edu.sjtu.json.Response<Object> alterData(long instanceId,
                                                            String data)

已过时。

编程的改变工作流实例的数据（变量）

参数:

instanceId - 工作流实例Id

data - 表单数据的JSON,通过data参数指定的（字段/变量名->值）的哈希表来修改、追加表单数据

返回:

结果

alter

@Deprecated
public edu.sjtu.json.Response<Object> alter(long instanceId,
                                                        InstanceState state,
                                                        String data,
                                                        String reason)

已过时。

编程的改变工作流实例的状态或者数据（变量）

参数:

instanceId - 工作流实例Id

state - 工作流状态 Offline: 挂起 Resume: 恢复 Complete: 完成 Terminate: 中止 Null: 不改变状态，仅修改表单数据/变量

data - 表单数据的JSON,通过data参数指定的（字段/变量名->值）的哈希表来修改、追加表单数据

reason - 挂起原因

返回:

结果

queryUsers

public edu.sjtu.json.Response<Profile> queryUsers(String workflowCode,
                                                  String accounts,
                                                  String positions)

5.5 获取用户

参数:

workflowCode - 流程代码，对应的流程应具有sys_triple授权

accounts - 用户帐号，可逗号分割多个

positions - 岗位部门过滤条件，同User控件的UserFilters设置

返回:

响应的用户信息

getUsersInPosition

public edu.sjtu.json.Response<Profile> getUsersInPosition(String workflowCode,
                                                          String positionCode,
                                                          String depCode)

6.2 获取岗位中的用户

参数:

workflowCode - 流程代码，对应的流程应具有sys_triple授权

positionCode - 岗位代码，必需提供

depCode - 部门代码，可选

返回:

响应的用户信息

getCodeItems

public edu.sjtu.json.Response<CodeItem> getCodeItems(String workflowCode,
                                                     String codeType,
                                                     String codeId)

9.6 获取代码表中的代码项

参数:

workflowCode - 流程代码，对应流程应具有sys_code授权

codeType - 代码表代码

codeId - 代码项代码，可选

返回:

响应的代码项信息

createCodeItem

public edu.sjtu.json.Response<CodeItem> createCodeItem(String workflowCode,
                                                       String codeType,
                                                       CodeItem codeItem)

9.6 向代码表新增代码项

参数:

workflowCode - 流程代码，对应流程应具有sys_code授权

codeType - 代码表代码

codeItem - 代码项

返回:

新增的代码项信息

modifyCodeItem

public edu.sjtu.json.Response<CodeItem> modifyCodeItem(String workflowCode,
                                                       String codeType,
                                                       CodeItem codeItem)

9.6 修改代码表代码项

参数:

workflowCode - 流程代码，对应流程应具有sys_code授权

codeType - 代码表代码

codeItem - 代码项

返回:

修改的代码项信息

deleteCodeItem

public edu.sjtu.json.Response<Object> deleteCodeItem(String workflowCode,
                                                     String codeType,
                                                     String codeId)

9.6 删除代码表的代码项

参数:

workflowCode - 流程代码，对应流程应具有sys_code授权

codeType - 代码表代码

codeId - 代码项代码

返回:

调用结果