com.frameworkset.platform.cms.customform

接口 CustomFormManager

所有超级接口:

java.io.Serializable

所有已知实现类:

CustomFormManagerImpl

public interface CustomFormManager
extends java.io.Serializable

自定义表单接口

方法概要

限定符和类型	方法和说明
boolean	addCustomForms(java.lang.String id, java.util.List customForms) 设置文档的各项自定义表单
boolean	addDocExtField(DocExtField docExtField) 新增一项扩展字段
boolean	addDocExtFields(java.lang.String[] ids, java.lang.String type, java.lang.String id) 从所有扩展字段中选择一些作为自己的扩展字段，是一种引用关系
boolean	delDocExtField(java.lang.String[] ids) 删除扩展字段（在维护界面上删）
boolean	delDocExtFieldOfSiteOrChl(java.lang.String[] ids, java.lang.String type, java.lang.String id) 删除具体的站点或频道的扩展字段
java.lang.String	getCustomFormFilename(java.lang.String targetId, java.lang.String targetType, java.lang.String formType) get设置文档的自定义表单的filename
java.util.List<DocExtField>	getDataFieldList(java.lang.String type, java.lang.String id, java.lang.String docid)
java.util.Map<java.lang.String,DocExtField>	getDataFieldMap(java.lang.String type, java.lang.String id, java.lang.String docid)
java.util.List	getDocExtFieldList() get所有的扩展字段列表
java.util.List	getDocExtFieldOfSiteOrChlList(java.lang.String id, java.lang.String type) get具体的站点或频道的扩展字段列表
DocExtField	getExtFieldBy(java.lang.String id) 根据扩展字段ID取得其内容
boolean	hasSameFieldName(java.lang.String fieldName) 新增一项扩展字段前 判断是否存在字段名字相同的情况
boolean	saveDocExtFieldValues(java.lang.String docid, java.lang.String[] ids, java.lang.String[] values, java.lang.String[] types) 保存文档的扩展字段的内容
boolean	setCustomForm(java.lang.String targetId, java.lang.String targetType, java.lang.String formType, java.lang.String fileName) 设置文档的各项自定义表单
boolean	updateCustomFormSet(java.lang.String targetId, java.lang.String targetType, java.lang.String formType, java.lang.String fileName) update设置文档的各项自定义表单
boolean	updateDocExtField(DocExtField docExtField) 修改一项扩展字段

方法详细资料

getDataFieldList

java.util.List<DocExtField> getDataFieldList(java.lang.String type,
                                             java.lang.String id,
                                             java.lang.String docid)
                                      throws CustomFormManagerException

抛出:

CustomFormManagerException

getDataFieldMap

java.util.Map<java.lang.String,DocExtField> getDataFieldMap(java.lang.String type,
                                                            java.lang.String id,
                                                            java.lang.String docid)
                                                     throws CustomFormManagerException

抛出:

CustomFormManagerException

setCustomForm

boolean setCustomForm(java.lang.String targetId,
                      java.lang.String targetType,
                      java.lang.String formType,
                      java.lang.String fileName)
               throws CustomFormManagerException

设置文档的各项自定义表单

参数:

TARGET_ID -

TARGET_TYPE -

FORM_TYPE -

FILE_NAME -

返回:

boolean

抛出:

CustomFormManagerException

addCustomForms

boolean addCustomForms(java.lang.String id,
                       java.util.List customForms)
                throws CustomFormManagerException

设置文档的各项自定义表单

参数:

List -

返回:

boolean

抛出:

CustomFormManagerException

updateCustomFormSet

boolean updateCustomFormSet(java.lang.String targetId,
                            java.lang.String targetType,
                            java.lang.String formType,
                            java.lang.String fileName)
                     throws CustomFormManagerException

update设置文档的各项自定义表单

参数:

TARGET_ID -

TARGET_TYPE -

FORM_TYPE -

FILE_NAME -

返回:

boolean

抛出:

CustomFormManagerException

getCustomFormFilename

java.lang.String getCustomFormFilename(java.lang.String targetId,
                                       java.lang.String targetType,
                                       java.lang.String formType)
                                throws CustomFormManagerException

get设置文档的自定义表单的filename

参数:

TARGET_ID -

TARGET_TYPE -

FORM_TYPE -

FILE_NAME -

返回:

String

抛出:

CustomFormManagerException

hasSameFieldName

boolean hasSameFieldName(java.lang.String fieldName)
                  throws CustomFormManagerException

新增一项扩展字段前 判断是否存在字段名字相同的情况

参数:

String - fieldName

返回:

boolean

抛出:

CustomFormManagerException

addDocExtField

boolean addDocExtField(DocExtField docExtField)
                throws CustomFormManagerException

新增一项扩展字段

参数:

docExtField -

返回:

boolean

抛出:

CustomFormManagerException

addDocExtFields

boolean addDocExtFields(java.lang.String[] ids,
                        java.lang.String type,
                        java.lang.String id)
                 throws CustomFormManagerException

从所有扩展字段中选择一些作为自己的扩展字段，是一种引用关系

参数:

String[] - ids

String - type 1：站点 2：频道

String - id 站点或频道的id

抛出:

CustomFormManagerException

delDocExtField

boolean delDocExtField(java.lang.String[] ids)
                throws CustomFormManagerException

删除扩展字段（在维护界面上删）

参数:

String[] - ids

返回:

boolean

抛出:

CustomFormManagerException

delDocExtFieldOfSiteOrChl

boolean delDocExtFieldOfSiteOrChl(java.lang.String[] ids,
                                  java.lang.String type,
                                  java.lang.String id)
                           throws CustomFormManagerException

删除具体的站点或频道的扩展字段

参数:

String[] - ids

String - type 1：站点 2：频道

String - id 站点或频道的id

返回:

boolean

抛出:

CustomFormManagerException

getDocExtFieldList

java.util.List getDocExtFieldList()
                           throws CustomFormManagerException

get所有的扩展字段列表

返回:

java.util.List

抛出:

CustomFormManagerException

getDocExtFieldOfSiteOrChlList

java.util.List getDocExtFieldOfSiteOrChlList(java.lang.String id,
                                             java.lang.String type)
                                      throws CustomFormManagerException

get具体的站点或频道的扩展字段列表

参数:

String - id 站点或频道的id

String - type 1：站点 2：频道

返回:

java.util.List

抛出:

CustomFormManagerException

saveDocExtFieldValues

boolean saveDocExtFieldValues(java.lang.String docid,
                              java.lang.String[] ids,
                              java.lang.String[] values,
                              java.lang.String[] types)
                       throws CustomFormManagerException

保存文档的扩展字段的内容

参数:

String - docid 文档的id

String[] - ids 该文档所有的扩展字段

String[] - values 相应的扩展字段内容

返回:

boolean

抛出:

CustomFormManagerException

getExtFieldBy

DocExtField getExtFieldBy(java.lang.String id)
                   throws CustomFormManagerException

根据扩展字段ID取得其内容

参数:

String - id 扩展字段id

返回:

java.util.List

抛出:

CustomFormManagerException

updateDocExtField

boolean updateDocExtField(DocExtField docExtField)
                   throws CustomFormManagerException

修改一项扩展字段

参数:

docExtField -

返回:

boolean

抛出:

CustomFormManagerException