CatalogService (Eaching-all 3.7 API)

All Superinterfaces:: IBase<Catalog>, IBaseService<Catalog>

public interface CatalogService
extends IBaseService<Catalog>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BeanMap<java.lang.String,java.lang.Object>`	`createCatalogData(Catalog catalog, LayoutData data, HttpServletRequest request)` 创建分类数据，用于外部接口调用的方法，内部调用请使用saveFormData()方法否则会清空当前用户登录状态标志。当前用户使用data.getOtherData().put(Constant.LOGIN_ID,"$uid");表示返回值BeanMap中有errNum的键值时表示脚本处理有异常，使用errMsg获取错误消息使用键retid获取得新增记录的ID
`int`	`generatorCatalogData(Catalog catalog, net.sf.json.JSONObject wfrequest)` 根据已有的数据ID生成分类数据权限，dataid是指所在的表单的数据ID，同request.dataid
`java.lang.String`	`getCatalogActionClazz(java.lang.String mid)` 如果当前$mid模块没有定义actionClazz则往上继承获取
`Catalog`	`getCatalogByFormid(java.lang.String formid)`
`Catalog`	`getCatalogByName(java.lang.String name, java.lang.String parentId)` 同一层级下的Catalog.name是唯一的不可重复根据名称和父级ID查找分类（目录）
`Catalog`	`getCatalogByNameAndParent(java.lang.String name, java.lang.String parentName)` 根据名称和父级名称查找分类（目录）
`java.lang.String`	`getCatalogFormid(java.lang.String mid)` 如果当前$mid模块没有定义formid则往上继承获取和自动判断权限控制.
`Layout`	`getCatalogLayout(java.lang.String mid, int layoutType)` 获取指定模块的指定类型的布局Id
`java.lang.String`	`getFolderPath(java.lang.String folderId)`
`java.lang.String`	`getFolderPath(java.lang.String folderId, int result)` 返回指定模块(分类)的上级路径
`java.util.Map<java.lang.String,java.lang.Object>`	`getGUIDType(java.lang.String guid)`
`java.util.Map<java.lang.String,java.lang.String>`	`getLayoutsByFormid(java.lang.String formid)`
`java.util.List<H5MenuItem>`	`getMenuBySiteid(java.lang.String siteid, boolean isSwitchUser)` 根据应用/站点ID获取子菜单，过滤掉微信的菜单
`java.lang.String[]`	`getParentCatalogid(java.lang.String cid)` 返回指定模块的所有上级的ID,包含本身
`java.lang.String`	`getRulePathByLabel(Catalog catalog)` 获取当前Catalog的RulePath,遇到inherit=0为结束
`java.util.List<Catalog>`	`getSubCatalog(java.lang.String catalogid, boolean isAll)` 获取下级分类，隐藏分类的不获取
`java.lang.String`	`getSubCatalogIds(java.lang.String catalogid, boolean isAll)`
`Catalog`	`getWxQyCatalog()` 获取微信企业号的站点配置模块
`boolean`	`isCatalog(java.lang.String catalogid)` 确定是否分类模块
`boolean`	`isFolder(java.lang.String catalogid)` 确定指定的catalogid是否为文件夹即知识管理下的分类模块
`java.lang.Object`	`processCatalogAction(Catalog catalog, LayoutData data, java.lang.String action, java.lang.Object[] args)`
`int`	`removeCatalogData(CatalogData cdata)` 删除分类引用记录，并不处理实际关联的表单数据，请使用removeFormData(Catalog,String);方法
`int`	`removeDataByCatalogid(java.lang.String catalogid, java.lang.String dataids)` 删除分类数据，并删除CatalogData，且调用Catalog的后处理action=delete事件
`int`	`removeFormData(Catalog catalog, java.lang.String dataids)` 删除分类数据，并删除CatalogData，且调用Catalog的后处理action=delete事件
`BeanMap<java.lang.String,java.lang.Object>`	`saveFormData(Catalog catalog, LayoutData data, Layout layout)`
`int`	`saveOrUpdate(Catalog catalog, boolean isUpdateRule)`
`java.lang.String`	`updateRulePath(Catalog catalog)` 更新当前模块分类的权限路径

Methods inherited from interface cn.sucang.core.service.IBaseService
invalidLabelCascade, recreateLabelCascade

Methods inherited from interface cn.sucang.core.IBase
executeUpdate, executeUpdate, getById, getById, getByQuery, getByWhere, getByWhere, getByWhere, getCounts, getCounts, getJdbcDao, getJdbcTemplate, getList, getListByWhere, getListByWhere, getListForQuery, getListForQuery, getNewItem, getPageList, getPageList, getPageListForQuery, remove, removeById, removeByObject, save, saveOrUpdate, saveOrUpdateByObject, updateLabelByOldLabel

- Method Detail
  - getSubCatalogIds
```
java.lang.String getSubCatalogIds(java.lang.String catalogid,
                                  boolean isAll)
```
  - getSubCatalog
```
java.util.List<Catalog> getSubCatalog(java.lang.String catalogid,
                                      boolean isAll)
```
    获取下级分类，隐藏分类的不获取
    
    Parameters:
    
    catalogid -
    
    isAll - as boolean //是否获取所有下级
    
    Returns:
    
    List<Catalog>
  - getFolderPath
```
java.lang.String getFolderPath(java.lang.String folderId)
```
  - getFolderPath
```
java.lang.String getFolderPath(java.lang.String folderId,
                               int result)
```
    返回指定模块(分类)的上级路径
    
    Parameters:
    
    folderId -
    
    result - as int //默认为0同getFolderPath(String)方法,1表示纯文本返回无href链接
    
    Returns:
  - getParentCatalogid
```
java.lang.String[] getParentCatalogid(java.lang.String cid)
```
    返回指定模块的所有上级的ID,包含本身
    
    Parameters:
    
    cid - as catalog.id
    
    Returns:
    
    String[]
  - getCatalogFormid
```
java.lang.String getCatalogFormid(java.lang.String mid)
```
    如果当前$mid模块没有定义formid则往上继承获取和自动判断权限控制.
    
    Parameters:
    
    mid - as String
    
    Returns:
    
    String
  - isFolder
```
boolean isFolder(java.lang.String catalogid)
```
    确定指定的catalogid是否为文件夹即知识管理下的分类模块
    
    Parameters:
    
    catalogid - as String
    
    Returns:
  - isCatalog
```
boolean isCatalog(java.lang.String catalogid)
```
    确定是否分类模块
    
    Parameters:
    
    catalogid - as String
    
    Returns:
  - getCatalogActionClazz
```
java.lang.String getCatalogActionClazz(java.lang.String mid)
```
    如果当前$mid模块没有定义actionClazz则往上继承获取
    
    Parameters:
    
    mid - as String
    
    Returns:
    
    String
  - getCatalogLayout
```
Layout getCatalogLayout(java.lang.String mid,
                        int layoutType)
```
    获取指定模块的指定类型的布局Id
    
    Parameters:
    
    mid - as String
    
    layoutType - as int //见Constant.LAYOUT_**,...
    
    Returns:
    
    FormEditPage
  - getLayoutsByFormid
```
java.util.Map<java.lang.String,java.lang.String> getLayoutsByFormid(java.lang.String formid)
```
  - getCatalogByFormid
```
Catalog getCatalogByFormid(java.lang.String formid)
```
  - getCatalogByName
```
Catalog getCatalogByName(java.lang.String name,
                         java.lang.String parentId)
```
    同一层级下的Catalog.name是唯一的不可重复根据名称和父级ID查找分类（目录）
    
    Parameters:
    
    name - as String
    
    parentId - as String //如果为NULL表示不检查父级关联,如果非GUID则表示hqlWhere条件
    
    Returns:
    
    Catalog
  - getCatalogByNameAndParent
```
Catalog getCatalogByNameAndParent(java.lang.String name,
                                  java.lang.String parentName)
```
    根据名称和父级名称查找分类（目录）
    
    Parameters:
    
    name - as String 名称
    
    parentName - as String //父目录名称
    
    Returns:
  - getRulePathByLabel
```
java.lang.String getRulePathByLabel(Catalog catalog)
```
    获取当前Catalog的RulePath,遇到inherit=0为结束
    
    Parameters:
    
    catalog - as Catalog
    
    Returns:
    
    String
  - updateRulePath
```
java.lang.String updateRulePath(Catalog catalog)
```
    更新当前模块分类的权限路径
    
    Parameters:
    
    catalog - as Catalog
    
    Returns:
    
    String
  - createCatalogData
```
BeanMap<java.lang.String,java.lang.Object> createCatalogData(Catalog catalog,
                                                             LayoutData data,
                                                             HttpServletRequest request)
```
    创建分类数据，用于外部接口调用的方法，内部调用请使用saveFormData()方法否则会清空当前用户登录状态标志。
    当前用户使用data.getOtherData().put(Constant.LOGIN_ID,"$uid");表示
    返回值BeanMap中有errNum的键值时表示脚本处理有异常，使用errMsg获取错误消息
    使用键retid获取得新增记录的ID
    
    Parameters:
    
    catalog -
    
    data -
    
    request -
    
    Returns:
    
    BeanMap<String, Object>
  - saveFormData
```
BeanMap<java.lang.String,java.lang.Object> saveFormData(Catalog catalog,
                                                        LayoutData data,
                                                        Layout layout)
```
  - removeFormData
```
int removeFormData(Catalog catalog,
                   java.lang.String dataids)
```
    删除分类数据，并删除CatalogData，且调用Catalog的后处理action=delete事件
    
    Parameters:
    
    catalog - as Catalog
    
    dataids - as String
    
    Returns:
    
    int
  - removeDataByCatalogid
```
int removeDataByCatalogid(java.lang.String catalogid,
                          java.lang.String dataids)
```
    删除分类数据，并删除CatalogData，且调用Catalog的后处理action=delete事件
    
    Parameters:
    
    catalogid - as String
    
    dataids - as String
    
    Returns:
  - removeCatalogData
```
int removeCatalogData(CatalogData cdata)
```
    删除分类引用记录，并不处理实际关联的表单数据，请使用removeFormData(Catalog,String);方法
    
    Parameters:
    
    cdata - as CatalogData
    
    Returns:
    
    int
  - generatorCatalogData
```
int generatorCatalogData(Catalog catalog,
                         net.sf.json.JSONObject wfrequest)
```
    根据已有的数据ID生成分类数据权限，dataid是指所在的表单的数据ID，同request.dataid
    
    Parameters:
    
    catalog - as Catalog
    
    wfrequest - as JSONObject(WfRequest) 如果为空则获取当前系统操作人员
    
    Returns:
    
    int //返回1表示生成成功，如果为-1表示已存在
  - processCatalogAction
```
java.lang.Object processCatalogAction(Catalog catalog,
                                      LayoutData data,
                                      java.lang.String action,
                                      java.lang.Object[] args)
```
  - saveOrUpdate
```
int saveOrUpdate(Catalog catalog,
                 boolean isUpdateRule)
```
  - getGUIDType
```
java.util.Map<java.lang.String,java.lang.Object> getGUIDType(java.lang.String guid)
```
  - getWxQyCatalog
```
Catalog getWxQyCatalog()
```
    获取微信企业号的站点配置模块
    
    Returns:
  - getMenuBySiteid
```
java.util.List<H5MenuItem> getMenuBySiteid(java.lang.String siteid,
                                           boolean isSwitchUser)
```
    根据应用/站点ID获取子菜单，过滤掉微信的菜单
    
    Parameters:
    
    appid -
    
    Returns:

Interface CatalogService

Method Summary

Methods inherited from interface cn.sucang.core.service.IBaseService

Methods inherited from interface cn.sucang.core.IBase

Method Detail

getSubCatalogIds

getSubCatalog

getFolderPath

getFolderPath

getParentCatalogid

getCatalogFormid

isFolder

isCatalog

getCatalogActionClazz

getCatalogLayout

getLayoutsByFormid

getCatalogByFormid

getCatalogByName

getCatalogByNameAndParent

getRulePathByLabel

updateRulePath

createCatalogData

saveFormData

removeFormData

removeDataByCatalogid

removeCatalogData

generatorCatalogData

processCatalogAction

saveOrUpdate

getGUIDType

getWxQyCatalog

getMenuBySiteid