Package net.risesoft.api

Class DocumentApiImpl

  • All Implemented Interfaces:
    DocumentApi
    @RestController
@RequestMapping(value="/services/rest/document",
                produces="application/json")
public class DocumentApiImpl
extends Object
implements DocumentApi
    办件操作接口
    Author:
    qinman, zhangchongjie
    Date:
    2022/12/20

    • Constructor Detail

      • DocumentApiImpl

        public DocumentApiImpl()

    • Method Detail

      • add

        public net.risesoft.pojo.Y9Result<OpenDataModel> add​(@RequestParam
                                                     String tenantId,
                                                     @RequestParam
                                                     String orgUnitId,
                                                     @RequestParam
                                                     String itemId,
                                                     @RequestParam
                                                     boolean mobile)
        新建办件
        Specified by:
        add in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情
        Since:
        9.6.6

      • addWithStartTaskDefKey

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> addWithStartTaskDefKey​(@RequestParam
                                                                              String tenantId,
                                                                              @RequestParam
                                                                              String orgUnitId,
                                                                              @RequestParam
                                                                              String itemId,
                                                                              @RequestParam
                                                                              String startTaskDefKey,
                                                                              @RequestParam
                                                                              boolean mobile)
        新建 用于一个开始节点经过排他网关到达多个任务节点的情况，具体到达哪个任务节点开始，需要由用户选择
        Specified by:
        addWithStartTaskDefKey in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        startTaskDefKey - 开始任务节点
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情
        Since:
        9.6.8

      • complete

        public net.risesoft.pojo.Y9Result<Object> complete​(@RequestParam
                                                   String tenantId,
                                                   @RequestParam
                                                   String orgUnitId,
                                                   @RequestParam
                                                   String taskId)
                                            throws Exception
        办件办结
        Specified by:
        complete in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        taskId - 任务id
        Returns:
        Y9Result<Object> 通用请求返回对象
        Throws:
        Exception - Exception
        Since:
        9.6.6

      • completeSub

        public net.risesoft.pojo.Y9Result<Object> completeSub​(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String orgUnitId,
                                                      @RequestParam
                                                      String taskId,
                                                      @RequestParam("userList")
                                                      List<String> userList)
                                               throws Exception
        办件办结
        Specified by:
        completeSub in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        taskId - 任务id
        Returns:
        Y9Result<Object> 通用请求返回对象
        Throws:
        Exception - Exception
        Since:
        9.6.6

      • docUserChoise

        public net.risesoft.pojo.Y9Result<DocUserChoiseModel> docUserChoise​(@RequestParam
                                                                    String tenantId,
                                                                    @RequestParam
                                                                    String userId,
                                                                    @RequestParam
                                                                    String orgUnitId,
                                                                    @RequestParam
                                                                    String itemId,
                                                                    @RequestParam
                                                                    String processDefinitionKey,
                                                                    @RequestParam
                                                                    String processDefinitionId,
                                                                    String taskId,
                                                                    @RequestParam
                                                                    String routeToTask,
                                                                    String processInstanceId)
        获取发送选人信息
        Specified by:
        docUserChoise in interface DocumentApi
        Parameters:
        tenantId - 租户id
        userId - 人员id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionKey - 流程定义key
        processDefinitionId - 流程定义Id
        taskId - 任务id
        routeToTask - 任务key
        processInstanceId - 流程实例id
        Returns:
        Y9Result<DocUserChoiseModel> 通用请求返回对象 - data是发送选人信息
        Since:
        9.6.6

      • edit

        public net.risesoft.pojo.Y9Result<OpenDataModel> edit​(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String orgUnitId,
                                                      @RequestParam
                                                      String itembox,
                                                      @RequestParam(required=false)
                                                      String taskId,
                                                      @RequestParam
                                                      String processInstanceId,
                                                      @RequestParam
                                                      String itemId,
                                                      @RequestParam
                                                      boolean mobile)
        编辑办件
        Specified by:
        edit in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itembox - 办件状态，todo（待办），doing（在办），done（办结）
        taskId - 任务id
        processInstanceId - 流程实例id
        itemId - 事项id
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • editDoing

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> editDoing​(@RequestParam
                                                                 String tenantId,
                                                                 @RequestParam
                                                                 String orgUnitId,
                                                                 @RequestParam
                                                                 String processInstanceId,
                                                                 @RequestParam
                                                                 String documentId,
                                                                 @RequestParam
                                                                 boolean isAdmin,
                                                                 @RequestParam
                                                                 ItemBoxTypeEnum itemBox)
        编辑办件
        Specified by:
        editDoing in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • editDone

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> editDone​(@RequestParam
                                                                String tenantId,
                                                                @RequestParam
                                                                String orgUnitId,
                                                                @RequestParam
                                                                String processInstanceId,
                                                                @RequestParam
                                                                String documentId,
                                                                @RequestParam
                                                                boolean isAdmin,
                                                                @RequestParam
                                                                ItemBoxTypeEnum itemBox)
        编辑办件
        Specified by:
        editDone in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        documentId -
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • editRecycle

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> editRecycle​(@RequestParam
                                                                   String tenantId,
                                                                   @RequestParam
                                                                   String orgUnitId,
                                                                   @RequestParam
                                                                   String processInstanceId,
                                                                   @RequestParam
                                                                   boolean mobile)
        编辑办件
        Specified by:
        editRecycle in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • editCopy

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> editCopy​(@RequestParam
                                                                String tenantId,
                                                                @RequestParam
                                                                String orgUnitId,
                                                                @RequestParam
                                                                String processSerialNumber,
                                                                @RequestParam
                                                                boolean mobile)
        编辑办件
        Specified by:
        editCopy in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processSerialNumber - 流程实例id
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • editTodo

        public net.risesoft.pojo.Y9Result<DocumentDetailModel> editTodo​(@RequestParam
                                                                String tenantId,
                                                                @RequestParam
                                                                String orgUnitId,
                                                                @RequestParam
                                                                String taskId,
                                                                @RequestParam
                                                                boolean mobile)
        编辑办件
        Specified by:
        editTodo in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        taskId - 任务id
        mobile - 是否手机端
        Returns:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        Since:
        9.6.6

      • parserUser

        public net.risesoft.pojo.Y9Result<List<String>> parserUser​(@RequestParam
                                                           String tenantId,
                                                           @RequestParam
                                                           String orgUnitId,
                                                           @RequestParam
                                                           String itemId,
                                                           @RequestParam
                                                           String processDefinitionId,
                                                           @RequestParam
                                                           String routeToTaskId,
                                                           @RequestParam(required=false)
                                                           String taskDefName,
                                                           @RequestParam(required=false)
                                                           String processInstanceId,
                                                           @RequestParam(required=false)
                                                           String multiInstance)
        解析当前任务节点配置的用户数据
        Specified by:
        parserUser in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionId - 流程定义id
        routeToTaskId - 任务key
        taskDefName - 任务名称
        processInstanceId - 流程实例id
        multiInstance - 是否多实例
        Returns:
        Y9Result<List<String>> 通用请求返回对象 - data是解析后的人员id
        Since:
        9.6.6

      • saveAndForwarding

        public net.risesoft.pojo.Y9Result<String> saveAndForwarding​(@RequestParam
                                                            String tenantId,
                                                            @RequestParam
                                                            String orgUnitId,
                                                            String processInstanceId,
                                                            String taskId,
                                                            String sponsorHandle,
                                                            @RequestParam
                                                            String itemId,
                                                            @RequestParam
                                                            String processSerialNumber,
                                                            @RequestParam
                                                            String processDefinitionKey,
                                                            @RequestParam
                                                            String userChoice,
                                                            String sponsorGuid,
                                                            @RequestParam
                                                            String routeToTaskId,
                                                            @RequestBody
                                                            Map<String,​Object> variables)
        带自定义变量发送
        Specified by:
        saveAndForwarding in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位 id
        processInstanceId - 流程实例id
        taskId - 任务id
        sponsorHandle - 是否主办人办理
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userChoice - 选择的发送人员
        sponsorGuid - 主办人id
        routeToTaskId - 任务key
        variables - 保存变量
        Returns:
        Y9Result<String> 通用请求返回对象
        Since:
        9.6.6

      • forwarding

        public net.risesoft.pojo.Y9Result<String> forwarding​(@RequestParam
                                                     String tenantId,
                                                     @RequestParam
                                                     String orgUnitId,
                                                     @RequestParam
                                                     String taskId,
                                                     @RequestParam
                                                     String userChoice,
                                                     @RequestParam
                                                     String routeToTaskId,
                                                     @RequestParam(required=false)
                                                     String sponsorHandle,
                                                     @RequestParam(required=false)
                                                     String sponsorGuid)
        带自定义变量发送
        Specified by:
        forwarding in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位 id
        taskId - 任务id
        sponsorHandle - 是否主办人办理
        userChoice - 选择的发送人员
        sponsorGuid - 主办人id
        routeToTaskId - 任务key
        Returns:
        Y9Result<String> 通用请求返回对象
        Since:
        9.6.6

      • saveAndForwardingByTaskKey

        public net.risesoft.pojo.Y9Result<String> saveAndForwardingByTaskKey​(@RequestParam
                                                                     String tenantId,
                                                                     @RequestParam
                                                                     String orgUnitId,
                                                                     String processInstanceId,
                                                                     String taskId,
                                                                     String sponsorHandle,
                                                                     @RequestParam
                                                                     String itemId,
                                                                     @RequestParam
                                                                     String processSerialNumber,
                                                                     @RequestParam
                                                                     String processDefinitionKey,
                                                                     @RequestParam
                                                                     String userChoice,
                                                                     String sponsorGuid,
                                                                     @RequestParam
                                                                     String routeToTaskId,
                                                                     @RequestParam
                                                                     String startRouteToTaskId,
                                                                     @RequestBody
                                                                     Map<String,​Object> variables)
        指定任务节点发送
        Specified by:
        saveAndForwardingByTaskKey in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        taskId - 任务id
        sponsorHandle - 是否主办人办理
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userChoice - 选择的发送人员
        sponsorGuid - 主办人id
        routeToTaskId - 任务key
        startRouteToTaskId - 启动节点key
        variables - 保存变量
        Returns:
        Y9Result<String> 通用请求返回对象
        Since:
        9.6.6

      • saveAndSubmitTo

        public net.risesoft.pojo.Y9Result<Object> saveAndSubmitTo​(@RequestParam
                                                          String tenantId,
                                                          @RequestParam
                                                          String orgUnitId,
                                                          String taskId,
                                                          @RequestParam
                                                          String itemId,
                                                          @RequestParam
                                                          String processSerialNumber)
        提交并发送
        Specified by:
        saveAndSubmitTo in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位 id
        taskId - 任务id
        itemId - 事项id
        processSerialNumber - 流程编号
        Returns:
        Y9Result<Object> 通用请求返回对象
        Since:
        9.6.6

      • signTaskConfig

        public net.risesoft.pojo.Y9Result<SignTaskConfigModel> signTaskConfig​(@RequestParam
                                                                      String tenantId,
                                                                      @RequestParam
                                                                      String orgUnitId,
                                                                      @RequestParam
                                                                      String itemId,
                                                                      @RequestParam
                                                                      String processDefinitionId,
                                                                      @RequestParam
                                                                      String taskDefinitionKey,
                                                                      @RequestParam
                                                                      String processSerialNumber)
        获取签收任务配置
        Specified by:
        signTaskConfig in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionId - 流程定义id
        taskDefinitionKey - 任务key
        processSerialNumber - 流程编号
        Returns:
        Y9Result<SignTaskConfigModel> 通用请求返回对象 - data是签收任务配置
        Since:
        9.6.6

      • startProcess

        public net.risesoft.pojo.Y9Result<StartProcessResultModel> startProcess​(@RequestParam
                                                                        String tenantId,
                                                                        @RequestParam
                                                                        String orgUnitId,
                                                                        @RequestParam
                                                                        String itemId,
                                                                        @RequestParam
                                                                        String processSerialNumber,
                                                                        @RequestParam
                                                                        String processDefinitionKey)
        启动流程
        Specified by:
        startProcess in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        Returns:
        Y9Result<StartProcessResultModel> 通用请求返回对象 - data是启动流程返回信息
        Throws:
        Exception - Exception
        Since:
        9.6.6

      • startProcessByTheTaskKey

        public net.risesoft.pojo.Y9Result<StartProcessResultModel> startProcessByTheTaskKey​(@RequestParam
                                                                                    String tenantId,
                                                                                    @RequestParam
                                                                                    String orgUnitId,
                                                                                    @RequestParam
                                                                                    String itemId,
                                                                                    @RequestParam
                                                                                    String processSerialNumber,
                                                                                    @RequestParam
                                                                                    String processDefinitionKey,
                                                                                    @RequestParam(required=false)
                                                                                    String startTaskDefKey,
                                                                                    @RequestBody
                                                                                    List<String> startOrgUnitIdList)
        启动流程
        Specified by:
        startProcessByTheTaskKey in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        Returns:
        Y9Result<StartProcessResultModel> 通用请求返回对象 - data是启动流程返回信息
        Throws:
        Exception - Exception
        Since:
        9.6.6

      • startProcess

        public net.risesoft.pojo.Y9Result<StartProcessResultModel> startProcess​(@RequestParam
                                                                        String tenantId,
                                                                        @RequestParam
                                                                        String orgUnitId,
                                                                        @RequestParam
                                                                        String itemId,
                                                                        @RequestParam
                                                                        String processSerialNumber,
                                                                        @RequestParam
                                                                        String processDefinitionKey,
                                                                        @RequestParam
                                                                        String userIds)
        启动流程（多人）
        Specified by:
        startProcess in interface DocumentApi
        Parameters:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userIds - 人员、岗位ids
        Returns:
        Y9Result<StartProcessResultModel> 通用请求返回对象 - data是启动流程返回信息
        Throws:
        Exception - Exception
        Since:
        9.6.6