CMS服务接口定义.doc

北京融汇兴业网络技术有限公司基于UBSI的CMS服务功能定义文件编号：版 本 号：编制人：肖坤菊 编制日期：2010年7月20日审核人： 审核日期：200*年*月*日批准人： 批准日期：200*年*月*日 分发号： 北京融汇兴业网络技术有限公司2010年7月文档管理信息表主题：版本：1.0内容：关键字：参考文档：提交时间：创建人：文档修改记录表修改时间修改内容修改人批准人生效日期2010-7-16肖坤菊1 文档介绍本文档将描述管理会计系统的概要设计、功能模块划分以及数据结构设计。1.1 文档目的1.2 读者对象本文档的读者对象为。2 CMS服务调用说明及示例CMS服务的名称：rewin.ecsn.newcms.CMS客户端通过调用rewin.ubsi.Client.sendRequest方法向UBSI服务发送请求。该方法的参数如下：参数0:UBSI服务的名称，如cms服务的名称是rewin.ecsn.cms.CMS参数1:服务支持的功能名称，cms服务的功能名称以后面定义的“CMS服务功能定义”中的“功能名称”为准。参数2:必须是一个Object数组，数组的长度以及数组元素类型以各服务功能定义的“请求数据”为准。各服务功能定义处的“请求数据”中的0,1N代表请求参数数组Object中的数组元素。rewin.ubsi.Client.sendRequest方法的返回值说明：该方法的返回值是一个Object数组，数组的长度以及数组元素以各服务功能定义的“返回数据”为准，各服务功能定义处的“返回数据”中的0,1N代表返回值数组Object中数据元素。“新建栏目”功能调用举例：rewin.ubsi.Client client = rewin.ubsi.Client.newInstance(0);Object param = new Object6;param0 = 交易提示;param1 = “0001”;param2 = 交易提示信息;param3 = new Integer(2);param4 = new Integer(0);param5 = new Integer(0);Object r = client.sendRequest(rewin.ecsn.newcms.CMS, addClass, param);if(r != null & r.length 0 & r0 != null) String classid = (String)r0; /获得栏目id 3 CMS服务功能3.1 栏目类3.1.1 新建栏目功能名称addClass功能描述修改栏目属性请求数据序号域标识域名称类型及长度必要描述0name栏目名称String(255)Y1Type栏目建立方式IntegerY0:手工建立；1:自动建立（信息转换程序建立）2status栏目状态IntegerY0:正常；1:停用3description栏目描述String(2048)4parentid父栏目idString(255)Y“-1”表示根栏目5Infoformat信息格式IntegerY本栏目下的信息允许的格式：0:html，1:txt如短信栏目只能是txt的信息6Infomaxsize信息长度IntegerY本栏目下的信息正文允许的最大长度，单位是字节B如果为0,表示无限制7ratifyFlag信息是否要审核IntegerY本栏目下的信息是否要审核，0:需要（信息保存时是待审状态）；1:不需要（即信息一保存就是发布状态）8Userid创建人的idString(128)Y9username创建人的姓名String(128)Y10Reservedint1保留数字1Integer11ReservedInt2保留数字2Integer12ReservedInt3保留数字3Integer13ReservedChar1保留字符1String（256）14ReservedChar2保留字符2String（512）15ReservedChar3保留字符3String（1024）返回数据序号域标识域名称类型及长度描述0id栏目idString(255)新建栏目的id，如果为“0”说明新建失败备注信息3.1.2 修改栏目属性功能名称modifyClass功能描述修改栏目属性请求数据序号域标识域名称类型及长度必要描述0id栏目的idString(255) Y需要修改的栏目的id1name栏目的名字String(255)Y2status栏目的状态IntegerY0:正常；1:停用3description栏目的描述String(2048)4Infoformat信息格式IntegerY本栏目下的信息允许的格式：0:html，1:txt如短信栏目只能是txt的信息5Infomaxsize信息长度IntegerY本栏目下的信息正文允许的最大长度，单位是字节B如果为0,表示无限制6ratifyFlag信息是否要审核IntegerY本栏目下的信息是否要审核，0:需要（信息保存时是待审状态）；1:不需要（即信息一保存就是发布状态）7Userid修改人的idString(128)Y8username修改人的姓名String(128)Y9ReservedInt1保留数字1Integer10ReservedInt2保留数字2Integer11ReservedInt3保留数字3Integer12ReservedChar1保留字符1String（256）13ReservedChar2保留字符2String（512）14ReservedChar3保留字符3String（1024）返回数据序号域标识域名称类型及长度描述0Result修改结果Booleantrue：修改成功false：修改失败备注信息3.1.3 删除栏目功能名称deleteClass功能描述删除栏目;如果该栏目下有子栏目或者该栏目下有信息，则该栏目不能删除。请求数据序号域标识域名称类型及长度必要描述0id栏目的idString(255) Y待删除栏目的id返回数据序号域标识域名称类型及长度描述0Result操作结果Integer0:删除成功1:该栏目下有子栏目，删除失败2:该栏目下有信息，删除失败3:其他原因删除失败备注信息3.1.4 获得栏目的属性功能名称getClassDetail功能描述获得指定栏目的属性请求数据序号域标识域名称类型及长度必要描述0id栏目idString(255) Y栏目id返回数据序号域标识域名称类型及长度描述0id栏目idString1Name栏目名称String2Type栏目建立方式Integer0:手工建立；1:自动建立（信息转换程序建立）3Status栏目状态Integer0:正常；1:停用4Description栏目描述String5Parentid父栏目idString6Infoformat信息格式Integer本栏目下的信息允许的格式：0:html，1:txt如短信栏目只能是txt的信息7Infomaxsize信息长度Integer本栏目下的信息正文允许的最大长度，单位是字节B如果为0,表示无限制8ratifyFlag信息是否要审核Integer本栏目下的信息是否要审核，0:需要（信息保存时是待审状态）；1:不需要（即信息一保存就是发布状态）9Userid最后修改人的idString(128)10username最后修改人的姓名String(128)11Modifytime最后修改时间Java.util.Date12ReservedInt1保留数字1Integer13ReservedInt2保留数字2Integer14ReservedInt3保留数字3Integer15ReservedChar1保留字符1String（256）16ReservedChar2保留字符2String（512）17ReservedChar3保留字符3String（1024）备注信息如果栏目不存在，则返回数据为null3.1.5 获得栏目全路径功能名称getClassPath功能描述获得指定栏目的全路径，即从根节点开始的全路径（从根节点开始）请求数据序号域标识域名称类型及长度必要描述0id栏目的idString(255) Y栏目的id，多个栏目之间用英文,分隔；如果有多个栏目，返回的结果顺序与此参数中的栏目顺序一致返回数据序号域标识域名称类型及长度描述0栏目0Object2 Obj2元素说明见备注N栏目N同上同上备注信息Object Obj2中的每一个元素是一个Object2 obj3,其中obj30为与参数顺序对应的栏目的id，obj31为该栏目的全路径；如果这个栏目不存在，则obj3为null；obj3中的每个元素又是一个Object node,代表栏目全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点的类型：0:手工建立；1:自动建立调用举例：上述代码运行的结果：3.1.6 获得栏目的tree数据功能名称getClassTree功能描述获得指定栏目下的所有子栏目或者一级子栏目的tree数据请求数据序号域标识域名称类型及长度必要描述0id栏目的idString Y“-1”表示从根节点开始1Flag标识IntegerY0:只查一级子节点1:查全部子节点2status节点状态Integer缺省为-2全部。 0:正常；1:停用3Order排序条件,包含升降序信息，也支持对多个属性进行排序如name asc,id descStringN只限对栏目的下列属性进行排序：id（栏目id）name(栏目名称)返回数据序号域标识域名称类型及长度描述0父栏目与其一级子栏目的对象集合Object2一个父栏目id以及该父栏目的一级子栏目对象集合：0:String父栏目的id1:Object,子栏目集合，长度是子栏目的个数；其中每一个元素是一个Object,各个元素是子栏目的属性，属性顺序详见备注信息。同上同上同上N同上同上同上备注信息子栏目属性数组元素：0:String,栏目id1:String，栏目名称2:String，父栏目id3:String，栏目描述信息5:Integer，栏目状态，0:正常；1:停用6:Integer，栏目建立方式，0:手工建立；1:自动建立（信息转换程序建立）调用端可以不用关心本方法的返回值的顺序；通过调用rewin.ubsi.util.MapUtil.getMap(Object objArray)方法将结果转换为HashMap对象，该对象的元素如下：Key：String，父栏目的id，Value：java.util.Vector,所属该父栏目的一级子栏目的集合，其中的每个元素是Object,代表一个子栏目的属性数组，详细的顺序见第一段“子栏目属性数组元素说明”每个有子栏目的栏目的id都会是该HashMap对象中的一个key，通过该HashMap可以很容易的构造一颗栏目树。3.1.7 查询栏目功能名称queryClass功能描述根据指定的栏目名称查询栏目，栏目名称匹配规则为：栏目名称%.返回找到的各个栏目的全路径请求数据序号域标识域名称类型及长度必要描述0name栏目名称StringY查找栏目名称以name开始的各个栏目1Orderby排序条件String只限对栏目的下列属性进行排序：id（栏目id）name(栏目名称)排序条件中要指定对属性是升序还是降序2status状态Integer缺省为-2全部。 0:正常；1:停用3PageIndex页次Integer如果不指定，默认为14PageSize每页显示条数Integer如果不指定，默认为10返回数据序号域标识域名称类型及长度描述OTotalCount总记录数Integer1PageCount总页数Integer2CurCount当前页记录数Integer3Record栏目记录集合Object数据格式见备注信息备注信息返回值中的第3个数组元素是一个Objectobj1,obj1中每个元素是一个Object obj2,obj2中的每一个元素是一个Object2 obj3,其中obj30为栏目的id，obj31为该栏目的全路径；obj3中的每个元素又是一个Object node,代表栏目全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点的类型：0:手工建立；1:自动建立这里的返回值格式与“获得栏目全路径”方法中的完全一致，可参见那里。3.1.8 查询子栏目功能名称getClassChilds功能描述查询指定父频道ID的子频道请求数据序号域标识域名称类型及长度必要描述0parentID父栏目idStringY1status状态IntegerY0正常，1禁用2过滤条件String 不需要写where排序StringName desc当前页码Integer默认1每页条数Integer默认10返回数据序号域标识域名称类型及长度描述0总记录数Integer 1记录集Object obj详见备注备注信息Object0 classObj0 ID String 栏目ID classObj1 name String 栏目名称 classObj2 type int 栏目类别 classObj3 status int 栏目状态，如没有值，默认为1 classObj4 description String 栏目描述 classObj5 parentId String 父类别ID classObj6 infoformat int 栏目允许格式 classObj7 infoMaxSize int 正文最大长度 classObj8 ratifyFlagint是否需要审核标识 classObj9 userID String 修改人ID classObj10 userName String 修改人姓名 classObj11 modifyTime Date 修改时间 classObj12 reservedInt1 int备用整型字段1 classObj13 reservedInt2 int 备用整型字段2 classObj14 reservedInt3 int 备用整型字段3 classObj15 reservedChar1 String备用字符字段1 classObj16 reservedChar2 String备用字符字段2 classObj17 reservedChar3 String备用字符字段3.3.2 频道类3.2.1 新建频道功能名称addChannel功能描述新建频道请求数据序号域标识域名称类型及长度必要描述0name频道名称String(255)Y1parentid父频道idString(255)Y“-1”表示根频道2description频道描述String(2048)3classorder频道显示顺序IntegerY4status频道状态IntegerY0:正常；1:停用5type频道类型IntegerY0:需要与栏目对应的频道1:直接打开一个URL的频道6URL频道的URLString(255)如果type为0,这个属性有效7imageURL频道展示图片的URLString(255)8viewurl预览本频道下的信息列表的URL9Userid创建人的idString(128)Y10username创建人的姓名String(128)Y11ReservedInt1保留数字1Integer12ReservedInt2保留数字2Integer13ReservedInt3保留数字3Integer14ReservedChar1保留字符1String（256）15ReservedChar2保留字符2String（512）16ReservedChar3保留字符3String（1024）返回数据序号域标识域名称类型及长度描述0id频道idString(255)新建频道的id，如果为“0”说明新建失败备注信息3.2.2 修改频道属性功能名称modifyChannel功能描述修改频道属性请求数据序号域标识域名称类型及长度必要描述0id频道的idCHAR(2) Y待修改的频道的id1name频道名称Y2description频道描述String(2048)3classorder频道显示顺序IntegerY4status频道状态IntegerY0:正常；1:停用5URL频道的URLString(255)Y如果原频道的type为0,这个属性有效6imageURL频道展示图片的URLString(255)7Viewurl预览本频道下的信息列表的URLString(255)8Userid创建人的idString(128)Y9username创建人的姓名String(128)Y10ReservedInt1保留数字1Integer11ReservedInt2保留数字2Integer12ReservedInt3保留数字3Integer13ReservedChar1保留字符1String（256）14ReservedChar2保留字符2String（512）15ReservedChar3保留字符3String（1024）返回数据序号域标识域名称类型及长度描述0Result修改结果Booleantrue：修改成功false：修改失败备注信息3.2.3 删除频道功能名称deleteChannel功能描述删除频道。如果频道下有子频道，则该频道不能删除。请求数据序号域标识域名称类型及长度必要描述0id频道的idString(255) Y待删除频道的id返回数据序号域标识域名称类型及长度描述0Result操作结果Integer0：删除成功1：该频道下有子频道，不能删除2:删除失败备注信息3.2.4 获得频道属性功能名称getChannelDetail功能描述获得指定频道的属性请求数据序号域标识域名称类型及长度必要描述0id频道的idString(255) Y频道的id返回数据序号域标识域名称类型及长度描述0id频道idString1Name频道名称String2Parentid父频道idString3Description频道描述String4classorder频道显示顺序Integer5Status频道状态Integer0:正常；1:停用6Type频道类型Integer0:需要与栏目对应的频道1:直接打开一个URL的频道7URL频道的URLString如果type为0,这个属性有效8imgURL频道展示图片的URLString9viewurl预览本频道下的信息列表的URLstring10Userid最后修改人的idString(128)11username最后修改人的姓名String(128)12Modifytime最后修改时间Java.util.Date13ReservedInt1保留数字1Integer14ReservedInt2保留数字2Integer15ReservedInt3保留数字3Integer16ReservedChar1保留字符1String（256）17ReservedChar2保留字符2String（512）18ReservedChar3保留字符3String（1024）备注信息如果频道不存在，则返回数据为null3.2.5 获得频道全路径功能名称getChannelPath功能描述获得指定频道的全路径，即从根节点开始的全路径请求数据序号域标识域名称类型及长度必要描述0id频道idString(255) Y频道id，多个id之间用英文逗号分隔返回数据序号域标识域名称类型及长度描述0频道0Object Obj2元素说明见备注N频道N同上同上备注信息Object Obj2中的每一个元素是一个Object2 obj3,其中obj30为与参数顺序对应的频道的id，obj31为该频道的全路径；如果这个栏目不存在，则obj3为null；obj3中的每个元素又是一个Object node,代表栏目全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点类型：1:视图；2:URL该方法的返回值与“获得栏目全路径”的返回值很类似，可以参考那里的调用例子。3.2.6 获得频道的tree数据功能名称getChannelTree功能描述获得指定频道下的所有子频道或者一级子频道的tree数据请求数据序号域标识域名称类型及长度必要描述0id频道idString Y“-1”表示从根节点开始1Flag标识IntegerY0:只查一级子节点1:查全部子节点2status节点状态Integer缺省为-2全部。 0:正常；1:停用3Order排序条件，包含升降序信息，要可以根据属性进行排序条件的组合，如id desc,classorder ascString只限对频道的下列属性进行排序：classorder（显示顺序）id（频道id）name（频道名字）返回数据序号域标识域名称类型及长度描述0父频道与其一级子频道的对象集合Object2一个父频道id以及该父频道的一级子频道对象集合：0:String父频道的id1:Object,子频道集合，长度是子频道的个数；其中每一个元素是一个Object,各个元素是子频道的属性，属性顺序详见备注信息。同上同上同上N同上同上同上备注信息子频道属性数组元素：0:String,频道id1:String，频道名称2:String，父频道id3:String，频道描述信息4:Integer，频道显示顺序5:Integer，频道状态，0:正常；1:停用6:Integer，频道类型，0:需要与栏目对应的频道，1:直接打开一个URL的频道7:String，频道的URL，如果type为0,这个属性有效8:String，频道展示图片的URL，（2010-11-3修改）9: String ，ReservedInt1 扩展属性10: String ，ReservedInt2扩展属性11: String ，ReservedInt13扩展属性12：String ，ReservedChar1扩展属性13：String ，ReservedChar2扩展属性14：String ，ReservedChar3扩展属性调用端可以不用关心本方法的返回值的顺序；通过调用rewin.ubsi.util.MapUtil.getMap(Object objArray)方法将结果转换为HashMap对象，该对象的元素如下：Key：String，父频道的id，Value：java.util.Vector,所属该父节点的一级子节点的集合，其中的每个元素是Object,代表一个子频道的属性数组，详细的顺序见第一段“子频道属性数组元素说明”每个有子频道的频道的id都会是该HashMap对象中的一个key，通过该HashMap可以很容易的构造一颗频道树。3.2.7 查询频道功能名称queryChannel功能描述根据指定的频道名称查询栏目，频道名称匹配规则为：栏目名称%.返回找到的各个频道的全路径请求数据序号域标识域名称类型及长度必要描述0name栏目名称StringY查找栏目名称以name开始的各个栏目1Orderby排序条件String只限对频道的下列属性进行排序：classorder（显示顺序）id（频道id）2status节点状态Integer缺省为-2全部。 0:正常；1:停用3PageIndex页次Integer如果不指定，默认为14PageSize每页显示条数Integer如果不指定，默认为10返回数据序号域标识域名称类型及长度描述OTotalCount总记录数Integer1PageCount总页数Integer2CurCount当前页记录数Integer3Record栏目记录集合Object数据格式见备注信息备注信息返回值中的第3个数组元素是一个Objectobj1,obj1中每个元素是一个Object obj2,obj2中的每一个元素是一个Object2 obj3,其中obj30为频道的id，obj31为该频道的全路径； obj3中的每个元素又是一个Object node,代表频道全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点类型：1:视图；2:URL3.2.8 建立频道与栏目的对应功能名称addView功能描述建立一个频道与多个栏目之间的对应关系；如果该频道与其中的某些栏目已经有对应关系了，则不会重复建立，只会建立那些还没有的对应关系请求数据序号域标识域名称类型及长度必要描述0viewid频道idString(255) Y1classid栏目id串stringY多个栏目id之间用英文逗号分隔返回数据序号域标识域名称类型及长度描述0Result操作结果BooleanTrue：成功；False：失败1Reason失败代码String失败的错误描述见“备注”备注信息可能失败的错误原因：频道不存在栏目不存在3.2.9 取消频道与栏目对应功能名称deleteView功能描述取消一个频道与多个栏目之间的对应关系，也可不指定栏目，即取消这个频道所有的栏目对应关系。请求数据序号域标识域名称类型及长度必要描述0viewid频道的idString Y1classid栏目的id列表String多个栏目id之间用英文逗号分隔。如果该参数为空，表示取消这个频道的所有对应关系。返回数据序号域标识域名称类型及长度描述0Result操作结果BooleanTrue：成功；False：失败备注信息3.2.10 查询频道与栏目的对应功能名称getViewClass功能描述查询某个频道与哪些栏目建立了对应关系请求数据序号域标识域名称类型及长度必要描述0Channelid频道的idStringY返回数据序号域标识域名称类型及长度描述0栏目0Object obj2关于obj2的结构详见备注N栏目N同上同上备注信息Object Obj2中的每一个元素是一个Object2 obj3,其中obj30为找到的栏目的id，obj31为该栏目的全路径； obj3中的每个元素又是一个Object node,代表栏目全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点的类型：0:手工建立；1:自动建立3.2.11 查询栏目与频道的对应功能名称GetViewChannel功能描述查询某个栏目与哪些频道建立了对应关系请求数据序号域标识域名称类型及长度必要描述0Classid栏目的idStringY返回数据序号域标识域名称类型及长度描述0频道0Object2 obj2关于obj2的结构详见备注N频道N同上同上备注信息Object Obj2中的每一个元素是一个Object2 obj3,其中obj30为找到的频道的id，obj31为该频道的全路径；obj3中的每个元素又是一个Object node,代表频道全路径上的一个节点信息，节点信息node的属性顺序如下：0:Integer，节点的id1:String，节点的名称2:Integer，节点的状态，0:正常，1:停用3:Integer，节点类型：1:视图；2:URL3.2.12 查询子频道功能名称getChannelChilds功能描述查询指定父频道ID的子频道请求数据序号域标识域名称类型及长度必要描述0parentID父频道idStringY1status状态IntegerY0正常，1禁用2过滤条件String 不需要写where排序StringName desc当前页码Integer默认1每页条数Integer默认10返回数据序号域标识域名称类型及长度描述0总记录数Integer 1记录集Object obj详见备注备注信息Object0record0 String 频道IDrecord1 String 频道名称record2 String 父IDrecord3 String 描述record4 Integer 显示顺序record5 Integer 状态record6 Integer 频道类型(1视图，2URL)record7 String URLrecord8 String 图片URLrecord9 Integer 备用整形字段1record10 Integer 备用整形字段2record11 Integer 备用整形字段3record12 String 备用字符型字段1record13 String 备用字符型字段2record14 String 备用字符型字段3.3.3 信息类3.3.1 上传附件功能名称addAttachment功能描述客户端需要进行附件上传时，调用本功能获得附件应保存的物理路径、访问URL以及一个附件id，然后客户端自己将附件保存在这个方法指定的物理路径下，并且记住附件id，在需要保存信息时，将该附件id传给新建信息功能或者修改信息功能。请求数据序号域标识域名称类型及长度必要描述0filename附件的原始文件名称StringY如a.txt1Filesize附件大小IntegerY2Desc附件描述String返回数据序号域标识域名称类型及长度描述0id附件的idInteger如果为0,表示操作失败1Filepath附件的物理保存路径String不含附件更名后的完整路径，如d:attachment2010072Filename附件的新名字String备注信息3.3.2 新建信息功能名称addInfo功能描述新建一条信息，包括关联与该信息的附件;如果新建时指定了信息的关键字，本方法会自动找到包含这些关键字的其他信息，作为该信息的相关信息。请求数据序号域标识域名称类型及长度必要描述0classid信息所属栏目的idstring Y多个栏目id之间用英文逗号分隔1title信息标题String（255）Y2introduce信息简介String1000）3keywords关键字String（512）4createtime创建时间date5lasaccesstime最后访问时间date6orifinaltime信息的原始时间date7ModifyTime最后修改时间date8ExpireTime过期时间date9poster信息提交者的呢称StringY10author信息作者String11posterID提交者的用户IDStringY12source信息的来源String13infoLevel信息级别Integer信息级别14importance重要程度Integer15urgency紧急程度Integer16InfoValue自定义用途Integer17Status信息的当前状态Integer:0 发布1 待审-1 打回18Category相关股票，行业String19newflagNew标志Integer0:不设置，1:设置20topflag置顶标志Integer0:不设置，1:设置21hotflagHot标志Integer0:不设置，1:设置22Sourceid源idString自动转入信息在源表中的id23ReservedInt1保留字段Integer24ReservedInt2Integer25ReservedInt3Integer26ReservedChar1String27ReservedChar2String28ReservedChar3String29content信息正文String30contenttype正文类型Integer指明Content字段中所存内容的格式:0 TXT1 HTML2 URL3 附件31Attachmentid附件的idSt