中国普天项目信息管理系统之工程成本管理service接口文档.doc

工程成本管理模块service设计文档 V1.1通信产业事业本部工程管理系统工程成本管理Service设计文档V1.1二零零九年八月撰写时间作者备注2009-8-20王晓琳根据最初需求撰写设计文档2009-8-21史爱霞修改部分Service方法目 录1申报工程预算Service11.1功能点11.1.1填写月度预算表11.1.2浏览月度预算表11.1.3删除月度预算表11.1.4分解预算类别11.1.5设定审批人11.1.6浏览项目总预算11.1.7提交项目预算表11.2接口21.2.1DeclareProjectBudgetService（申报工程预算Service）22审批预算表Service52.1功能点52.1.1驳回预算表52.1.2通过预算表52.1.3发送提醒邮件52.1.4查看预算表类别明细52.1.5查看月度预算52.1.6查看已审批的项目预算52.1.7待办事宜52.2接口62.2.1ApproveProjectBudgetService（审批预算表Service）63记录费用支出Service73.1功能点73.1.1填写费用支出73.1.2修改费用支出73.1.3提交费用支出73.2接口73.2.1RecordCostExpenditureService（记录费用支出Service）74管理预算类别Service84.1功能点84.1.1创建费用类别84.1.2修改费用类别84.1.3删除费用类别84.1.4恢复费用类别94.1.5增加预算类别子项94.1.6删除预算类别子项94.1.7恢复预算类别子项94.2接口94.2.1ManageBudgetCategoryService（管理预算类别Service）95审批模板设定Service115.1功能点115.1.1增加审批步骤115.1.2删除审批步骤115.1.3修改审批步骤115.2接口125.2.1SetApprovalTemplateService（审批模板设定Service）126查询汇总核算Service136.1功能点136.1.1单个项目预算与支出的汇总核算136.1.2单个项目汇总结果导出136.1.3查看单个项目汇总结果柱状图136.1.4多个项目月度预算与支出总额的汇总核算136.1.5多项目汇总时查看单个项目月度详情136.2接口136.2.1InquiryGatherAccountingService（查询汇总核算Service）131 申报工程预算Service1.1 功能点1.1.1 填写月度预算表功能点：增加月度预算表，修改月度预算记录，删除月度预算记录1.1.2 浏览月度预算表功能点：查看未提交的月度预算表1.1.3 删除月度预算表功能点：删除未提交的月度预算表1.1.4 分解预算类别功能点：增加费用类别明细记录，删除费用类别明细记录1.1.5 设定审批人功能点：设定审批人1.1.6 浏览项目总预算功能点：查看项目预算表1.1.7 提交项目预算表功能点：提交项目预算表1.2 接口1.2.1 DeclareProjectBudgetService（申报工程预算Service）序号方法功能说明1Int addCostMonthlyBudget (E_costMonthlyBudgetBean monthlybudget)增加月度预算表参数：monthlybudget为月预算表的bean对象，类型为E_costMonthlyBudgetBEean，其属性包括年，月，项目Id，费用类别记录list。返回值为0，1，2说明如下：0：增加成功1：增加失败2：在保存过程中发生异常，增加失败2Int modifyCostMonthlyBudgetRecord(String E_costMonthlyBudgetId, String E_costMonthlyBudgetRecordId)修改月度预算记录参数：E_costMonthlyBudgetId为月度预算表的Id， E_costMonthlyBudgetRecordId为要修改月度预算记录表的Id，类型为String返回值：0，1，2说明如下：0：修改成功1：修改失败2：在修改过程中发生异常，修改失败3Int deleteCostMonthlyBudget (String E_costMonthlyBudgetId,String state)删除未提交的月度预算表参数：E_costMonthlyBudgetId为要删除的月度预算表的Id，类型为String;state为月度预算表的状态，此为待审批返回值：0，1，2说明如下：0：删除成功1：删除失败2：在删除过程中发生异常，删除失败4List getBeforepostMonthlyBudget(String projectId, String state)浏览未提交的月度预算表参数：projectId为工程的Id，state为预算表的状态，此为未提交返回值：List，它为月度预算表的集合5List inquiryBeforepostMonthlyBudget(String projectId,String start_year,String start_month,String end_year,String end_month，String state)查询未提交的月度预算表参数：projectId为工程的Id，start_year为起始年，start_month为起始月，end_year为结束年，end_month为结束月，类型都为String; state为月度预算表的状态，此为待审批返回值：List，它为月度预算表的集合6Int addCostCategoryDetailRecord(E_costCategoryDetailRecordBean costCategoryDetail)增加费用类别明细记录参数：costCategoryDetail为费用类别明细记录的Bean对象，类型为E_costCategoryDetailRecordBean，其属性包括工程Id，类别Id，类别明细的list（类别明细的Id和记录值）返回值：0，1，20：增加成功1：增加失败2：在增加过程中发生异常，增加失败7Int deleteCostCategoryDetailRecord(String projectId, String categoryId)删除费用类别明细记录参数：projectId要删除的类别明细的工程id，categoryId 类别id返回值：0，1，20：删除成功1：删除失败2：在删除过程中发生异常，删除失败8Int setJudge(String projectId ,String judgeId, String step_no，String role)设定审批人参数：budgetId为预算表的Id，judgeId为选定的人员的Id，role为要成为的审批人角色，类型都为String返回值：0，1，20：设定成功1：设定失败2：在操作过程中发生异常，设定失败9E_costTotalBudgetRecord getCostTotalBudget(String projectId)查看项目预算表参数：projectId为工程Id，类型为String返回值类型为E_costTotalBudgetRecord，是项目预算总记录10Int postTotalBudget(String projectId)提交项目预算表参数：projectId为工程Id，类型为String返回值：0，1，20：提交成功1：提交失败2：提交过程中发生异常，提交失败11List getCostMonthlyBuget(String year, String month, String projectId, String state)按年月查询未提交月度预算表参数：year为年，month为月，projectId为工程的Id，state为状态，此处为未提交，类型为String返回值为E_costCategory月度预算表的list12List getJudge(String projected)查看审批人参数：projectId为工程的Id返回值为E_costApprovalFlow审批流程的list2 审批预算表Service2.1 功能点2.1.1 驳回预算表功能点：驳回审批预算表2.1.2 通过预算表功能点：通过预算表2.1.3 发送提醒邮件功能点：发送提醒邮件2.1.4 查看预算表类别明细功能点：查看费用类别明细记录2.1.5 查看月度预算功能点：查看月度预算2.1.6 查看已审批的项目预算功能点：查看已审批的项目预算2.1.7 待办事宜功能点：查看待审批的预算表2.2 接口2.2.1 ApproveProjectBudgetService（审批预算表Service）序号方法功能说明1Int approveProjectBudget(String budgetId, String isPass, String opinion, String step_no, String isInform)审批预算表参数：budgetId为预算表Id，isPass为审批结果，表示通过还是驳回，opinion是审批意见，step_no为目前的审批步骤，isInform为是否邮件通知，类型都为String返回值：0，1，20：审批成功1：审批失败2：在审批过程中发生异常，审批失败2List getBeforepostMonthlyBudget(String projectId, String state)查看月度预算表参数：projectId为工程的Id，state为预算表的状态，此为待审批或审批返回值：List，它为月度预算表的集合3List get CostCategoryDetailRecord(String totalbudget_id, String category_id)查看预算类别内容详情参数：totalbudget_id为预算总表的Id，category_id为费用类别的Id），类型为String返回值为E_costCategoryDetailRecord费用类别明细记录的list4List getCostTotalBudget(String state，String judgeId)查看项目预算表参数：state为状态，此处为待审批或已审批，类型为String . judgeId为审批人id返回值为E_costTotalBudgetRecord项目预算总表记录的list5Int sendMail（String judget_id）发送邮件提醒参数：judget_id为审批人的Id，类型为String返回值：0，10：发送成功1：发送失败7List getApprovalFlowLog(String projected)查看流水日志参数：projectId为工程Id，类型为String返回值为E_costApprovalFlowLog流转日志的list3 记录费用支出Service3.1 功能点3.1.1 填写费用支出功能点：填写实际费用支出3.1.2 修改费用支出功能点：修改实际费用支出3.1.3 提交费用支出功能点：提交已记录的支出费用记录3.2 接口3.2.1 RecordCostExpenditureService（记录费用支出Service）序号方法功能说明1Int addMonthlyCostExpenditure(E_costMonthlyBudgetBean costmonthlybudget)填写月度费用支出参数：costmonthlybudget为月度预算表的bean对象，类型为E_costMonthlyBudgetBean返回值：0，1，20：保存成功1：保存失败2：在保存过程中出现异常，保存失败2List getMonthlyCosExpenditure(String projectId)查看月度费用支出参数：projectId为工程的Id返回值：3Int postMonthlyCostExpenditure(String costmonthlybudgetId)提交月度费用支出参数：costmonthlybudgetId为要提交的月度费用表返回值：0，1，20：提交成功1：提交失败2：在提交过程中出现异常，提交失败4 管理预算类别Service4.1 功能点4.1.1 创建费用类别功能点：创建费用类别4.1.2 修改费用类别功能点：修改预算类别备注4.1.3 删除费用类别功能点：删除预算类别4.1.4 恢复费用类别功能点：恢复之前删除的预算类别4.1.5 增加预算类别子项功能点：增加预算类别子项4.1.6 删除预算类别子项功能点：删除预算类别子项4.1.7 恢复预算类别子项功能点：恢复预算类别子项4.2 接口4.2.1 ManageBudgetCategoryService（管理预算类别Service）序号方法功能说明1Int addCostCategory(E_costCategoryBeancostcategory)增加预算类别参数：costcategory为项目费用类别表的bean对象，类型为E_costCategoryBean返回值：0，1，20：增加成功1：增加失败2：在增加过程中发生异常，增加失败2Int modifyCostCategory(String costcategoryId, E_costCategoryBeanCostcategory, String formula)修改预算类别参数：costcategoryId为项目费用类别表的Id，类型为String, costcategory为E_costCategoryBean类型，为项目费用类别表的对象Formula为需要输入的公式，类型为String返回值：0，1，20：修改成功1：修改失败2：在修改过程中发生异常，修改失败3Int deleteCostCategory(String costcategoryId)删除预算类别参数：costcategoryId为项目费用类别表的Id，类型为String返回值：0，1，20：删除成功1：删除失败2：在删除过程中发生异常，删除失败4Int restoreCostCategory(String costcategoryId)恢复预算类别参数：costcategoryId为项目费用类别表的Id，类型为String返回值：0，1，20：恢复成功1：恢复失败2：在恢复过程中发生异常，恢复失败5List getCostCategoryDetail(String costcategoryId)查看预算类别明细参数：costcategoryId为项目费用类别表的Id，类型为String返回值为E_costCategoryDetail预算类别明细的list6Int addCostCategoryDetail(E_costCategoryDetailBean costcategorydetailbean)增加预算类别明细参数：costcategorydetailbean为项目费用类别明细的bean对象，类型为E_costCategoryDetailBean返回值：0，1，20：增加成功1：增加失败2：在增加过程中出现异常，增加失败7Int deleteCostCategoryDetail(String costcategorydetailId)删除预算类别明细参数：costcategorydetailId为项目费用类别明细的Id类型为String返回值：0，1，20：删除成功1：删除失败2：在删除过程中出现异常，删除失败8Int restoreCostCategoryDetail(String costcategorydetailId)恢复预算类别明细参数：costcategorydetailId为项目费用类别明细的Id，类型为String返回值：0，1，20：恢复成功1：恢复失败2：在恢复过程中发生异常，恢复失败9List getCostCategory()查看所有费用类别返回值 E_costCategory 封装费用类别的dto5 审批模板设定Service5.1 功能点5.1.1 增加审批步骤功能点：增加一步审批流程5.1.2 删除审批步骤功能点：删除一步审批流程5.1.3 修改审批步骤功能点：修改一步审批流程5.2 接口5.2.1 SetApprovalTemplateService（审批模板设定Service）序号方法功能说明1Int addApprovalTemplate(E_costApprovalTemplateBean approvaltemplate) 增加审批步骤参数：approvaltemplatemplate为模板审批步骤的bean对象，类型为E_costApprovalTemplateBean返回值：0，1，20：增加成功1：增加失败2：在增加过程中出现异常，增加失败2Int modifyApprovalTemplate(String templateId, E_costApprovalTemplateBean approvaltemplate)修改审批步骤参数：templateId为模板审批步骤Id，类型为String；approvaltemplatemplate为模板审批步骤的bean对象，类型为E_costApprovalTemplateBean返回值：0，1，20：修改成功1：修改失败2：在修改过程中出现异常，修改失败3Int deleteApprovalTemplate(String templateId)删除审批步骤参数：templateId为模板审批步骤Id，类型为String返回值：0，1，20：删除成功1：删除失败2：在删除过程中出现异常，删除失败4List getALlApprovalStep()查看审批步骤返回 值：E_costApprovalTemplate 封装 审批步骤的dto6 查询汇总核算Service6.1 功能点6.1.1 单个项目预算与支出的汇总核算功能点：汇总单个工程预算和支出情况6.1.2 单个项目汇总结果导出功能点：导出指定项目的月度预算的支出汇总情况6.1.3 查看单个项目汇总结果柱状图功能点：将查询到的单个项目核算情况做柱状图6.1.4 多个项目月度预算与支出总额的汇总核算功能点：汇总多个工程的预算支出情况6.1.5 多项目汇总时查看单个项目月度详情功能点：多项目汇总时查看单个项目月度详情6.2 接口6.2.1 InquiryGatherAccountingService（查询汇总核算Service）序号方法功能说明1List gatherSingleProjectAccouting(String projectId, String start_year, String start_month, String end_year, String end_month, String costcategory)查询单项目单类别汇总核算参数：projectId为项目Id，start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，costcategory为项目费用类别，类型为String返回值为E_costMonthlyBudgetRecord项目月度预算记录的list2List gatherSingleProjectAccouting(String projectId, String start_year, String start_month, String end_year, String end_month)查询单项目全部类别汇总核算参数：projectId为项目Id，start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，类型为String返回值为E_costMonthlyBudget项目月度预算的list3List gatherSingleProjectAccouting(String projectId, String start_year, String start_month, String end_year, String end_month, String costcategory)查询多项目单类别汇总核算参数：projectId为项目Id，j是个list；start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，costcategory为项目费用类别，类型为String返回值为E_costMonthlyBudgetRecord项目月度预算记录的list4List gatherSingleProjectAccouting(String projectId, String start_year, String start_month, String end_year, String end_month)查询多项目全部类别汇总核算参数：projectId为项目Id，j是个list；start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，类型为String返回值为E_costMonthlyBudget项目月度预算的list5Int exportAccouting(String projectId, String start_year, String start_month, String end_year, String end_month, String costcategory) 导出结果(单项目单类别汇总核算)参数：projectId为项目Id，start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，costcategory为项目费用类别，类型为String返回值：0，1，20：导出成功1：导出失败2：在导出过程中发生异常，导出失败6Int exportAccouting(String projectId, String start_year, String start_month, String end_year, String end_month)导出结果(单项目全部类别汇总核算)参数：projectId为项目Id，start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，类型为String返回值同上7Int exportAccouting(String projectId, String start_year, String start_month, String end_year, String end_month, String costcategory）导出结果(多项目单类别汇总核算）参数：projectId为项目Id，j是个list；start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，costcategory为项目费用类别，类型为String返回值同上8Int exportAccouting(String projectId, String start_year, String start_month, String end_year, String end_month）导出结果(多项目全部类别汇总核算）参数：projectId为项目Id，j是个list；start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，类型为String返回值同上9Int getHistogram(String projectId, String start_year, String start_month, String end_year, String end_month, String costcategory)查看柱状图（单项目单类别汇总核算）参数：projectId为项目Id，start_year为查询的起始年，start_month为查询的起始月，end_year为查询的结束年，end_month为查询的结束月，costcategory为项目费用类别，类型为String返回值：0，1，20：生成柱状图成功1：生成柱状图失败2：在生成柱状图的过程中发生异常，生成柱状图失败10Int getHistogram(String projectId, String start_year, String start_month, String end_year, String end_month)查看柱状图（单项目全部类别汇总核算）参数：projectId为项目Id，start_y