CatalogService

java.lang.Object
- smartbi.sdk.service.catalog.CatalogService

public class CatalogService
extends java.lang.Object

资源目录服务接口

构造器概要

构造器
构造器和说明

CatalogService(ClientConnector conn)

构造器
构造器和说明
`CatalogService(ClientConnector conn)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`copyAndPasteReturnNewId(java.lang.String toId, java.lang.String srcId, java.lang.String name, java.lang.String alias, java.lang.String desc)`
`ICatalogElement`	`createCatalogElement(java.lang.String parentId, java.lang.String id, java.lang.String name, java.lang.String alias, java.lang.String desc, int order, java.lang.String type)` 创建资源树结点需要注意的是，此方法是单纯新建一个树结点，调用此方法前，必须存在此结点类型的实体资源.
`ICatalogElement`	`createFolder(java.lang.String parentNodeId, java.lang.String name, java.lang.String alias, java.lang.String desc, java.lang.String type, boolean hiddenInBrowse)` 创建目录
`ICatalogElement`	`createFolderById(java.lang.String parentNodeId, java.lang.String id, java.lang.String name, java.lang.String alias, java.lang.String desc, java.lang.String type, boolean hiddenInBrowse)` 通过ID创建目录
`java.lang.String`	`createURLLink(java.lang.String parentFolderId, java.lang.String urlName, java.lang.String urlAlias, java.lang.String urlDesc, java.lang.String url, java.lang.String setting)` 创建WEB链接
`void`	`deleteCatalogElement(java.lang.String id)` 通过ID删除资源
`IResourcePermission`	`getAssignedPermissions(java.lang.String resId)` 获取资源直接被授予的权限信息
`ICatalogElement`	`getCatalogElementById(java.lang.String elementId)` 根据ID 访问资源
`java.util.List<? extends ICatalogElement>`	`getCatalogElementByType(java.lang.String type)` 通过类型获取结点
`java.util.List<? extends ICatalogElement>`	`getChildElements(java.lang.String nodeId)` 获得指定节点的子节点列表
`java.util.List<? extends ICatalogElement>`	`getChildElementsByTypes(java.lang.String parentNodeId, java.lang.String[] types)` 获取目录下指定类型的子元素
`java.util.List<? extends IResourcePermissionItem>`	`getInheritedPermissions(java.lang.String resId)` 获取资源继承的权限信息
`java.util.List`	`getRootElements()` 获得资源树的顶层节点列表
`boolean`	`isCatalogElementAccessible(java.lang.String elementId, java.lang.String type)` 判断某个资源是否可访问。
`java.util.List<ICatalogSearchResult>`	`searchCatalogElementLikeAlias(java.lang.String alias, java.lang.String purview)` 根据别名或名称模糊查询资源信息
`void`	`setAssignedPermissionByGroup(java.lang.String elementId, java.lang.String groupId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType, boolean isGroupDescend)` 设置该资源的组权限
`void`	`setAssignedPermissionByRole(java.lang.String elementId, java.lang.String roleId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType)` 设置该资源的角色权限
`void`	`setAssignedPermissionByUser(java.lang.String elementId, java.lang.String userId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType)` 设置该资源的用户权限
`void`	`updateCatalogElementImage(java.lang.String id, java.lang.String image)` 更换资源节点的图片
`void`	`updateCatalogNode(java.lang.String id, java.lang.String jsonNodeConfig, java.lang.String wholeExtended)` 根据ID修改资源信息
`void`	`updateURLLink(java.lang.String urlID, java.lang.String urlAlias, java.lang.String urlDesc, java.lang.String url, java.lang.String setting)` 更新WEB链接

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CatalogService
```
public CatalogService(ClientConnector conn)
```
    参数:
    
    conn - 连接器
- 方法详细资料
  - isCatalogElementAccessible
```
public boolean isCatalogElementAccessible(java.lang.String elementId,
                                          java.lang.String type)
```
    判断某个资源是否可访问。
    
    参数:
    
    elementId - 资源ID
    
    type - 访问类型:
    1.引用权限：REF
    2.查看权限：READ
    3.编辑权限：WRITE
    
    返回:
    
    true/false
  - getRootElements
```
public java.util.List getRootElements()
```
    获得资源树的顶层节点列表
    
    返回:
    
    顶层节点列表。节点类型为CatalogElement
  - getChildElements
```
public java.util.List<? extends ICatalogElement> getChildElements(java.lang.String nodeId)
```
    获得指定节点的子节点列表
    
    参数:
    
    nodeId - 指定节点ID
    
    返回:
    
    子节点列表。节点类型为CatalogElement
  - createFolder
```
public ICatalogElement createFolder(java.lang.String parentNodeId,
                                    java.lang.String name,
                                    java.lang.String alias,
                                    java.lang.String desc,
                                    java.lang.String type,
                                    boolean hiddenInBrowse)
```
    创建目录
    
    参数:
    
    parentNodeId - 父目录ID
    
    name - 目录名称
    
    alias - 目录别名
    
    desc - 目录描述
    
    type - 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
    
    hiddenInBrowse - 是否在浏览模块中隐藏此目录
    
    返回:
    
    资源对象
  - createFolderById
```
public ICatalogElement createFolderById(java.lang.String parentNodeId,
                                        java.lang.String id,
                                        java.lang.String name,
                                        java.lang.String alias,
                                        java.lang.String desc,
                                        java.lang.String type,
                                        boolean hiddenInBrowse)
```
    通过ID创建目录
    
    参数:
    
    parentNodeId - 父目录ID
    
    id - 目录ID
    
    name - 目录名称
    
    alias - 目录别名
    
    desc - 目录描述
    
    type - 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
    
    hiddenInBrowse - 是否在浏览模块中隐藏此目录
    
    返回:
    
    资源对象
  - createCatalogElement
```
public ICatalogElement createCatalogElement(java.lang.String parentId,
                                            java.lang.String id,
                                            java.lang.String name,
                                            java.lang.String alias,
                                            java.lang.String desc,
                                            int order,
                                            java.lang.String type)
```
    创建资源树结点需要注意的是，此方法是单纯新建一个树结点，调用此方法前，必须存在此结点类型的实体资源. 例如需要一个URL链接，只需要调用createURLLink方法即可，在createURLLink中会创建URL链接的实体资源，同时也会自动创建与之对应的资源树结点，无需再另外调用此方法. 如果需要新建其它类型的资源，只需要调用相对应的创建其资源的方法即可。
    
    参数:
    
    parentId - 父亲结点
    
    id - 资源ID，此参数设置为空，系统会自动创建这个资源ID
    
    name - 资源名称
    
    alias - 资源别名
    
    desc - 资源描述
    
    order - 资源排序
    
    type - 资源类型，目前具有的类型有：
    1.可视化查询:BUSINESS_VIEW
    2.SQL查询:TEXT_BUSINESS_VIEW
    3.存储过程查询:PROC_BUSINESS_VIEW
    4.原生SQL查询：RAWSQL_BUSINESS_VIEW
    5.灵活分析:SIMPLE_REPORT
    6.组合分析：COMBINED_QUERY
    7.透视分析：INSIGHT
    8.仪表分析: Dashboard
    9.地图分析: DashboardMap
    10.电子表格：SPREADSHEET_REPORT
    11.多维分析：OLAP_REPORT
    12.portal页面: PAGE
    13.WEB链接：URL
    14.SMARTBIX_DATASET：自助数据集
    15.SMARTBIX_PAGE：自助仪表盘 16.AUGMENTED_DATASET：数据模型
    17.指标模型：MT_MODEL
    18.模型SQL查询：AUGMENTED_SQL_VIEW
    
    返回:
    
    资源对象
  - setAssignedPermissionByUser
```
public void setAssignedPermissionByUser(java.lang.String elementId,
                                        java.lang.String userId,
                                        java.lang.String type,
                                        boolean inherited,
                                        java.lang.String permissionDescendType)
```
    设置该资源的用户权限
    
    参数:
    
    elementId - 资源ID
    
    userId - 用户ID
    
    type - 权限类型，有以下四种：
    没有权限：NONE
    引用权限：REF
    查看权限：READ
    编辑权限：WRITE
    删除权限：DELETE
    
    inherited - 是否允许父项的继承权限传播到该对象和所有子对象
    
    permissionDescendType - 权限应用范围，有以下几种：
    只有该目录：NONE
    该目录及子目录：FOLDER_ONLY
    该目录及文件：FILE_ONLY
    该目录、子目录及文件: FOLDER_FILE
  - setAssignedPermissionByRole
```
public void setAssignedPermissionByRole(java.lang.String elementId,
                                        java.lang.String roleId,
                                        java.lang.String type,
                                        boolean inherited,
                                        java.lang.String permissionDescendType)
```
    设置该资源的角色权限
    
    参数:
    
    elementId - 资源ID
    
    roleId - 角色ID
    
    type - 权限类型，有以下四种：
    没有权限：NONE
    引用权限：REF
    查看权限：READ
    编辑权限：WRITE
    删除权限：DELETE
    
    inherited - 是否允许父项的继承权限传播到该对象和所有子对象
    
    permissionDescendType - 权限应用范围，有以下几种：
    只有该目录：NONE
    该目录及子目录：FOLDER_ONLY
    该目录及文件：FILE_ONLY
    该目录、子目录及文件: FOLDER_FILE
  - setAssignedPermissionByGroup
```
public void setAssignedPermissionByGroup(java.lang.String elementId,
                                         java.lang.String groupId,
                                         java.lang.String type,
                                         boolean inherited,
                                         java.lang.String permissionDescendType,
                                         boolean isGroupDescend)
```
    设置该资源的组权限
    
    参数:
    
    elementId - 资源ID
    
    groupId - 组ID
    
    type - 权限类型，有以下四种：
    没有权限：NONE
    引用权限：REF
    查看权限：READ
    编辑权限：WRITE
    删除权限：DELETE
    
    inherited - 是否允许父项的继承权限传播到该对象和所有子对象
    
    permissionDescendType - 权限应用范围，有以下几种：
    只有该目录：NONE
    该目录及子目录：FOLDER_ONLY
    该目录及文件：FILE_ONLY
    该目录、子目录及文件: FOLDER_FILE
    
    isGroupDescend - 是否应用于子组
  - getAssignedPermissions
```
public IResourcePermission getAssignedPermissions(java.lang.String resId)
```
    获取资源直接被授予的权限信息
    
    参数:
    
    resId - 资源id
    
    返回:
    
    IResourcePermission 对象
  - getInheritedPermissions
```
public java.util.List<? extends IResourcePermissionItem> getInheritedPermissions(java.lang.String resId)
```
    获取资源继承的权限信息
    
    参数:
    
    resId - 资源id
    
    返回:
    
    IResourcePermission 对象
  - getCatalogElementById
```
public ICatalogElement getCatalogElementById(java.lang.String elementId)
```
    根据ID 访问资源
    
    参数:
    
    elementId - 资源ID
    
    返回:
    
    资源节点
  - getCatalogElementByType
```
public java.util.List<? extends ICatalogElement> getCatalogElementByType(java.lang.String type)
```
    通过类型获取结点
    
    参数:
    
    type - 资源类型，目前具有的类型为:
    1.可视化查询:BUSINESS_VIEW
    2.SQL查询:TEXT_BUSINESS_VIEW
    3.存储过程查询:PROC_BUSINESS_VIEW
    4.原生SQL查询：RAWSQL_BUSINESS_VIEW
    5.灵活分析:SIMPLE_REPORT
    6.组合分析：COMBINED_QUERY
    7.透视分析：INSIGHT
    8.仪表分析: Dashboard
    9.地图分析: DashboardMap
    10.电子表格：SPREADSHEET_REPORT
    11.多维分析：OLAP_REPORT
    12.portal页面: PAGE
    13.WEB链接：URL
    14.SMARTBIX_DATASET：自助数据集
    15.SMARTBIX_PAGE：自助仪表盘 16.AUGMENTED_DATASET：数据模型
    
    返回:
    
    资源对象列表
  - createURLLink
```
public java.lang.String createURLLink(java.lang.String parentFolderId,
                                      java.lang.String urlName,
                                      java.lang.String urlAlias,
                                      java.lang.String urlDesc,
                                      java.lang.String url,
                                      java.lang.String setting)
```
    创建WEB链接
    
    参数:
    
    parentFolderId - 父结点ID
    
    urlName - 名称
    
    urlAlias - 别名
    
    urlDesc - 描述
    
    url - URL地址
    
    setting - 设置是否新窗口打开以及是否传递登录信息
    设置在当前窗口打开设置如下: {"currentWindow":true}
    设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
    如果此值设置为空，则系统会默认为在新窗口打开并不传递登录信息
    
    返回:
    
    URL链接ID
  - updateURLLink
```
public void updateURLLink(java.lang.String urlID,
                          java.lang.String urlAlias,
                          java.lang.String urlDesc,
                          java.lang.String url,
                          java.lang.String setting)
```
    更新WEB链接
    
    参数:
    
    urlID - 结点ID
    
    urlAlias - 别名
    
    urlDesc - 描述
    
    url - URL地址
    
    setting - 设置是否新窗口打开以及是否传递登录信息
    设置在当前窗口打开设置如下: {"currentWindow":true}
    设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
    如果此值设置为空，则系统会默认为在新窗口打开并不传递登录信息
  - updateCatalogElementImage
```
public void updateCatalogElementImage(java.lang.String id,
                                      java.lang.String image)
```
    更换资源节点的图片
    
    参数:
    
    id - 资源ID
    
    image - 图片名
  - searchCatalogElementLikeAlias
```
public java.util.List<ICatalogSearchResult> searchCatalogElementLikeAlias(java.lang.String alias,
                                                                          java.lang.String purview)
```
    根据别名或名称模糊查询资源信息
    
    参数:
    
    alias - 别名或名称
    
    purview - "READ"："查看"； "WRITE"："编辑"； "REF"："引用"
    
    返回:
    
    List 匹配的节点列表
  - updateCatalogNode
```
public void updateCatalogNode(java.lang.String id,
                              java.lang.String jsonNodeConfig,
                              java.lang.String wholeExtended)
```
    根据ID修改资源信息
    
    参数:
    
    id - 资源ID
    
    jsonNodeConfig - 资源定义，json字符串，格式如下： "{\"alias\":\"复选框_报表2\",\"desc\":\"复选框_报表2\",\"deletedExtKeys\":\"hasChild,detectChild\",\"extended\":\"{'customImage':'Foldera.jpg','hiddenInBrowse':'false'}\"}" alias: 可选属性，别名 desc: 可选属性，描述 deletedExtKeys：可选属性，需要删除的扩展属性的key，参数内容可以不包含该属性 extended：可选属性，需要新增或修改的扩展属性内容，参数内容可以不包含该属性
    
    wholeExtended - 完整的扩展内容，json字符串，格式如下：{"extended": "{\"hasChild\":\"false\",\"hiddenInBrowse\":\"false\"}"}。该参数内容可为空。如不为空，扩展字段内容将全部替换为该参数内容，否则只对扩展属性进行增量添加。
  - deleteCatalogElement
```
public void deleteCatalogElement(java.lang.String id)
```
    通过ID删除资源
    
    参数:
    
    id - 资源ID
  - copyAndPasteReturnNewId
```
public java.lang.String copyAndPasteReturnNewId(java.lang.String toId,
                                                java.lang.String srcId,
                                                java.lang.String name,
                                                java.lang.String alias,
                                                java.lang.String desc)
```
    参数:
    
    toId - 目标目录Id
    
    srcId - 资源Id
    
    name - 副本名字
    
    alias - 副本别名
    
    desc - 副本描述
    
    返回:
    
    新节点ID
  - getChildElementsByTypes
```
public java.util.List<? extends ICatalogElement> getChildElementsByTypes(java.lang.String parentNodeId,
                                                                         java.lang.String[] types)
```
    获取目录下指定类型的子元素
    
    参数:
    
    parentNodeId - 父元素id
    
    types - 资源类型
    
    返回:
    
    子元素列表

类 CatalogService

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CatalogService

方法详细资料

isCatalogElementAccessible

getRootElements

getChildElements

createFolder

createFolderById

createCatalogElement

setAssignedPermissionByUser

setAssignedPermissionByRole

setAssignedPermissionByGroup

getAssignedPermissions

getInheritedPermissions

getCatalogElementById

getCatalogElementByType

createURLLink

updateURLLink

updateCatalogElementImage

searchCatalogElementLikeAlias

updateCatalogNode

deleteCatalogElement

copyAndPasteReturnNewId

getChildElementsByTypes