template.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. <?xml version="1.0" encoding="GB2312"?>
  2. <service provider="com.trs.ajaxservice.TemplateServiceProvider" objclass="com.trs.components.common.publish.persistent.template.Template">
  3. <method name="save" desc="保存指定模板的信息">
  4. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="false"/>
  5. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="false"/>
  6. <parameter name="ObjectId" desc="模板ID" type="int" required="false" default="0"/>
  7. </method>
  8. <method name="delete" desc="删除指定模板">
  9. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="false"/>
  10. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="false"/>
  11. <!--默认的参数,可以不写-->
  12. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="true"/>
  13. </method>
  14. <method name="query" desc="获取模板列表">
  15. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  16. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  17. <parameter name="ContainsChildren" desc="是否包含子对象的" type="boolean" required="false" default="false"/>
  18. <!--排序字段及方式-->
  19. <parameter name="OrderBy" desc="排序字段及方式" type="string" default="lastModifiedTime Desc" required="false"/>
  20. <parameter name="DateTimeFormat" desc="返回的日期格式" type="string" required="false" default="MM-dd HH:mm"/>
  21. <!-- 检索相关配置 BEGIN -->
  22. <parameter name="TempName" desc="查询的模板名称" type="string" required="false" search="true"
  23. search-operator="like"/>
  24. <parameter name="TempDesc" desc="查询的模板描述" type="string" required="false" search="true"
  25. search-operator="like"/>
  26. <parameter name="CrUser" desc="查询的模板创建者" type="string" required="false" search="true"
  27. search-operator="like"/>
  28. <parameter name="TempId" desc="查询的模板Id" type="int" required="false" search="true"
  29. search-operator="=" exclude-value="-1"/>
  30. <parameter name="ExcludeTempId" desc="需要排除的模板Id" type="int" required="false" search="true"
  31. search-operator="&lt;&gt;" exclude-value="0" search-field="TempId"/>
  32. <!-- 检索相关配置 END -->
  33. <!--提取的字段-->
  34. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType,FolderType,FolderId,CrUser,CrTime,lastModifiedTime,lastModifiedUser"/>
  35. </method>
  36. <method name="findByIds" >
  37. <!--默认的参数,可以不写-->
  38. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="true"/>
  39. <!--提取的字段-->
  40. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType,FolderType,FolderId,CrUser,CrTime,lastModifiedTime,lastModifiedUser"/>
  41. </method>
  42. <method name="findById" desc="根据模板ID获取模板信息">
  43. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="false"/>
  44. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="false"/>
  45. <parameter name="ObjectId" desc="模板ID" type="int" required="true"/>
  46. <!--提取的字段-->
  47. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType,FolderType,FolderId,CrUser,CrTime,TempExt,OutPutFileName,TempText,lastModifiedTime,lastModifiedUser"/>
  48. </method>
  49. <method name="findByIdWithoutText" truename="findById" desc="根据模板ID获取模板信息">
  50. <!--提取的字段-->
  51. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType,FolderType,FolderId,CrUser,CrTime,TempExt,OutPutFileName,lastModifiedTime,lastModifiedUser"/>
  52. </method>
  53. <!--获取选择单个或者多个模板的操作列表-->
  54. <method name="getOperators">
  55. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  56. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  57. <parameter name="ObjectId" desc="模板ID" type="int" required="false"/>
  58. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="false"/>
  59. </method>
  60. <!--获取指定对象可选择的模板列表-->
  61. <method name="getOptionalTemplates">
  62. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true" min-value="1"/>
  63. <parameter name="ObjectId" desc="对象(站点/栏目/文档)ID" type="int" required="true" min-value="1"/>
  64. <parameter name="TemplateType" desc="模板类型" type="int" required="true" min-value="-99"/>
  65. <!--排序字段及方式-->
  66. <parameter name="OrderBy" desc="排序字段及方式" type="string" default="lastModifiedTime Desc" required="false"/>
  67. <parameter name="DateTimeFormat" desc="返回的日期格式" type="string" required="false" default="MM-dd HH:mm"/>
  68. <!-- 检索相关配置 BEGIN -->
  69. <parameter name="TempName" desc="查询的模板名称" type="string" required="false" search="true"
  70. search-operator="like"/>
  71. <parameter name="TempDesc" desc="查询的模板描述" type="string" required="false" search="true"
  72. search-operator="like"/>
  73. <parameter name="CrUser" desc="查询的模板创建者" type="string" required="false" search="true"
  74. search-operator="like"/>
  75. <parameter name="TempId" desc="查询的模板Id" type="int" required="false" search="true"
  76. search-operator="=" exclude-value="-1"/>
  77. <!-- 检索相关配置 END -->
  78. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId, TempName ,TempDesc, TempType, CrUser, CrTime, FolderType, FolderId,lastModifiedTime,lastModifiedUser"/>
  79. </method>
  80. <!--获取指定站点可选择的模板列表-->
  81. <method name="getSiteOptionalTemplates" truename="getOptionalTemplates">
  82. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true" min-value="1" default="103"/>
  83. </method>
  84. <!--获取指定栏目可选择的模板列表-->
  85. <method name="getChannelOptionalTemplates" truename="getOptionalTemplates">
  86. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true" min-value="1" default="101"/>
  87. </method>
  88. <!--获取指定文档可选择的模板列表-->
  89. <method name="getDocumentOptionalTemplates" truename="getOptionalTemplates">
  90. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true" min-value="1" default="605"/>
  91. </method>
  92. <!-- 将指定对象(站点/栏目)的模板设置同步到所有子对象上 -->
  93. <method name="impartTemplateConfig" desc="同步模板设置"
  94. logger="com.trs.ajaxservice.logger.ImpartTemplateLogger">
  95. <parameter name="ObjectType" desc="对象(站点/栏目)类型" type="int" required="true" min-value="1"/>
  96. <parameter name="ObjectId" desc="对象(站点/栏目)ID" type="int" required="true" min-value="1"/>
  97. </method>
  98. <method name="queryEmployers" desc="获取指定模板的使用情况">
  99. <parameter name="ObjectId" desc="模板ID" type="int" required="true" min-value="1"/>
  100. <!-- 取消分页 -->
  101. <parameter name="PageSize" desc="分页大小" type="int" required="false" default="-1"/>
  102. </method>
  103. <method name="queryNestedTemplates" desc="获取指定模板使用嵌套模板的情况">
  104. <parameter name="ObjectId" desc="模板ID" type="int" required="true" min-value="1"/>
  105. <!-- 取消分页 -->
  106. <parameter name="PageSize" desc="分页大小" type="int" required="false" default="-1"/>
  107. <!--提取的字段-->
  108. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType, CrUser, CrTime, FolderType, FolderId,lastModifiedTime,lastModifiedUser"/>
  109. </method>
  110. <method name="export" desc="导出选中的模板">
  111. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  112. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  113. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="false"/>
  114. <parameter name="ExportAll" desc="是否导出所有" type="boolean" required="false" default="false"/>
  115. <parameter name="ContainsChildren" desc="是否包含子对象的" type="boolean" required="false" default="false"/> <!-- 检索相关配置 BEGIN -->
  116. <parameter name="TempName" desc="查询的模板名称" type="string" required="false" search="true"
  117. search-operator="like"/>
  118. <parameter name="TempDesc" desc="查询的模板描述" type="string" required="false" search="true"
  119. search-operator="like"/>
  120. <parameter name="CrUser" desc="查询的模板创建者" type="string" required="false" search="true"
  121. search-operator="like"/>
  122. <parameter name="TempId" desc="查询的模板Id" type="int" required="false" search="true"
  123. search-operator="=" exclude-value="-1"/>
  124. <parameter name="ExcludeTempId" desc="需要排除的模板Id" type="int" required="false" search="true"
  125. search-operator="&lt;&gt;" exclude-value="0" search-field="TempId"/>
  126. <!-- 检索相关配置 END -->
  127. </method>
  128. <method name="importTemplates" desc="从指定的文件导入模板" logger="com.trs.ajaxservice.logger.TemplateImportLogger">
  129. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  130. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  131. <parameter name="ImportFile" desc="要导入的文件" type="string" required="true"/>
  132. <parameter name="SrcFileName" desc="要导入的文件原文件名" type="string" required="true"/>
  133. <parameter name="FileEncode" desc="编码" type="string" required="false"/>
  134. <parameter name="ImportMode" desc="模板重名处理模式" type="int" required="false" default=""/>
  135. <parameter name="PicMode" desc="模板附件重名处理模式" type="int" required="false" defalt=""/>
  136. </method>
  137. <method name="check" desc="校验选中的模板">
  138. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="false"/>
  139. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="false"/>
  140. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="false"/>
  141. <parameter name="CheckAll" desc="是否校验当前对象下所有的模板" type="boolean" required="false"/>
  142. <parameter name="ContainsChildren" desc="是否校验子对象的" type="boolean" required="false"/>
  143. </method>
  144. <method name="checkTemplateText" desc="校验指定的内容">
  145. <parameter name="ObjectId" desc="模板ID" type="int" required="false"/>
  146. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  147. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  148. <parameter name="TemplateText" desc="模板内容" type="string" required="true"/>
  149. </method>
  150. <method name="redistributeAppendixes" desc="同步模板附件" logger="com.trs.ajaxservice.logger.ResyncTemplateApdLogger">
  151. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  152. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  153. <parameter name="ObjectIds" desc="模板ID序列" type="string" required="false"/>
  154. <parameter name="RedistributeAll" desc="是否分发当前对象下所有的模板(包括子对象)" type="boolean" required="false"/>
  155. </method>
  156. <method name="queryArgs" desc="获取站点/栏目的可设置的模板变量">
  157. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  158. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  159. </method>
  160. <method name="saveArgument" desc="保存在站点/栏目上设置模板变量值">
  161. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="true"/>
  162. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="true"/>
  163. <parameter name="TemplateId" desc="模板ID" type="int" required="true"/>
  164. <parameter name="ParameterName" desc="参数名称" type="string" required="true"/>
  165. <parameter name="PrexName" desc="参数前缀(默认为不传入)" type="string" required="false"/>
  166. <parameter name="ArgValue" desc="设置的参数值" type="string" required="true"/>
  167. </method>
  168. <method name="queryTemplatesNested" desc="获取嵌套模板的使用情况">
  169. <parameter name="ObjectId" desc="嵌套模板ID" type="int" required="true" min-value="1"/>
  170. <!-- 取消分页 -->
  171. <parameter name="PageSize" desc="分页大小" type="int" required="false" default="-1"/>
  172. <!--提取的字段-->
  173. <parameter name="SelectFields" desc="获取的字段列表" type="string" required="false" default="TempId,TempName,TempDesc,TempType, CrUser, CrTime, FolderType, FolderId,lastModifiedTime,lastModifiedUser"/>
  174. </method>
  175. <method name="setDefaultTemplate" desc="设置对象的默认模板">
  176. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true"/>
  177. <parameter name="ObjectId" desc="对象(站点/栏目/文档)ID" type="int" required="true"/>
  178. <parameter name="TemplateId" desc="模板ID" type="int" required="true"/>
  179. <parameter name="TemplateType" desc="模板类型" type="int" required="true"/>
  180. </method>
  181. <method name="setOtherOutlineTemplates" desc="设置对象的其它概览模板">
  182. <parameter name="ObjectType" desc="对象(站点/栏目/文档)类型" type="int" required="true"/>
  183. <parameter name="ObjectId" desc="对象(站点/栏目/文档)ID" type="int" required="true"/>
  184. <parameter name="TemplateIds" desc="模板ID序列" type="string" required="true"/>
  185. </method>
  186. <method name="existsSimilarName" desc="通用概览">
  187. <parameter name="SiteId" desc="站点ID" type="int" required="true"/>
  188. <parameter name="ObjectId" desc="模板ID" type="int" required="true"/>
  189. <parameter name="TempName" desc="模板名称" type="string" required="true"/>
  190. </method>
  191. <!--ge gfc add @ 2007-12-27-->
  192. <method name="setChannelEmployersOfTemplate" desc="分配模板到指定栏目或站点" provider="com.trs.ajaxservice.TemplateServiceHelperProvider"
  193. logger="com.trs.ajaxservice.logger.SetEmployersOfTemplateLogger">
  194. <parameter name="TemplateId" desc="模板ID" type="int" required="true"/>
  195. <parameter name="ChannelIds" desc="栏目ID序列" type="string" required="false"/>
  196. <parameter name="EmployOnSite" desc="是否同时设置站点的模板关系" type="boolean" required="false"/>
  197. </method>
  198. <method name="checkWCAG2TemplateText" desc="校验指定的内容">
  199. <parameter name="ObjectId" desc="模板ID" type="int" required="false"/>
  200. <parameter name="HostType" desc="对象(站点/栏目)类型" type="int" required="false"/>
  201. <parameter name="HostId" desc="对象(站点/栏目)ID" type="int" required="false"/>
  202. <parameter name="TemplateText" desc="模板内容" type="string" required="false"/>
  203. </method>
  204. </service>