smartbi.catalogtree

接口 ICatalogTreeWebService

public interface ICatalogTreeWebService

定义由WebService调用的方法，主要供第三方系统(非JAVA平台)使用

方法概要

限定符和类型	方法和说明
java.lang.String	copyAndPaste(java.lang.String toId, java.lang.String srcId, java.lang.String name, java.lang.String alias, java.lang.String desc) 将指定的资源复制到其它目录下，并重命名，然后返回复制后的资源ID。
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	createFolderElement(java.lang.String parentNodeId, java.lang.String name, java.lang.String alias, java.lang.String desc, java.lang.String type, boolean hiddenInBrowse, java.lang.String customImg)
IResourcePermission	getAssignedPermissions(java.lang.String id) 获取资源直接被授予的权限信息
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 parentId) 获得指定节点的子节点列表
java.util.List<? extends IResourcePermissionItem>	getInheritedPermissions(java.lang.String id) 获取资源继承的权限信息
java.util.List<? extends ICatalogElement>	getRootElements() 获得资源树的顶层节点列表
boolean	isCatalogElementAccessible(java.lang.String id, java.lang.String type) 判断某个资源是否可访问。
void	setAssignedPermissionByGroup(java.lang.String resId, java.lang.String groupId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType, boolean isGroupDescend) 设置该资源的组权限
void	setAssignedPermissionByRole(java.lang.String resId, java.lang.String roleId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType) 设置该资源的角色权限
void	setAssignedPermissionByUser(java.lang.String resId, java.lang.String userId, java.lang.String type, boolean inherited, java.lang.String permissionDescendType) 设置该资源的用户权限
void	setOwner(java.lang.String nodeId, java.lang.String ownerId, AssigneeType ownerType) 设置指定资源的所有者，可以将所有者设置为用户、用户组、或者角色。

方法详细资料

getRootElements

java.util.List<? extends ICatalogElement> getRootElements()

获得资源树的顶层节点列表

返回:

顶层节点列表。节点类型为CatalogElement

getChildElements

java.util.List<? extends ICatalogElement> getChildElements(java.lang.String parentId)

获得指定节点的子节点列表

参数:

parentId - 指定节点ID

返回:

子节点列表。节点类型为CatalogElement

getCatalogElementById

ICatalogElement getCatalogElementById(java.lang.String elementId)

根据ID 访问资源

参数:

elementId -

返回:

ICatalogElement

createFolder

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 - 是否在浏览界面隐藏此目录

返回:

资源对象

createFolderElement

ICatalogElement createFolderElement(java.lang.String parentNodeId,
                                    java.lang.String name,
                                    java.lang.String alias,
                                    java.lang.String desc,
                                    java.lang.String type,
                                    boolean hiddenInBrowse,
                                    java.lang.String customImg)

参数:

parentNodeId - 父目录ID

name - 子目录名称

alias - 子目录别名

desc - 子目录描述

type - 子目录类型,此项可为空,系统会自动根据父目录的类型进行设置

hiddenInBrowse - 是否在浏览界面隐藏此目录

customImg - 自定义图标路径

返回:

资源对象

getAssignedPermissions

IResourcePermission getAssignedPermissions(java.lang.String id)

获取资源直接被授予的权限信息

参数:

id - 资源id

返回:

IResourcePermission 对象

getInheritedPermissions

java.util.List<? extends IResourcePermissionItem> getInheritedPermissions(java.lang.String id)

获取资源继承的权限信息

参数:

id - 资源id

返回:

IResourcePermission 对象

setAssignedPermissionByUser

void setAssignedPermissionByUser(java.lang.String resId,
                                 java.lang.String userId,
                                 java.lang.String type,
                                 boolean inherited,
                                 java.lang.String permissionDescendType)

设置该资源的用户权限

参数:

resId - 资源ID

userId - 用户ID

type - 权限类型，有以下四种：
引用权限：REF
查看权限：READ
编辑权限：WRITE
管理权限：ALL

inherited - 是否允许父项的继承权限传播到该对象和所有子对象

permissionDescendType - 权限应用范围，有以下几种：
只有该目录：NONE
该目录及子目录：FOLDER_ONLY
该目录及文件：FILE_ONLY
该目录、子目录及文件: FOLDER_FILE

setAssignedPermissionByRole

void setAssignedPermissionByRole(java.lang.String resId,
                                 java.lang.String roleId,
                                 java.lang.String type,
                                 boolean inherited,
                                 java.lang.String permissionDescendType)

设置该资源的角色权限

参数:

resId - 资源ID

roleId - 角色ID

type - 权限类型，有以下四种：
引用权限：REF
查看权限：READ
编辑权限：WRITE
管理权限：ALL

inherited - 是否允许父项的继承权限传播到该对象和所有子对象

permissionDescendType - 权限应用范围，有以下几种：
只有该目录：NONE
该目录及子目录：FOLDER_ONLY
该目录及文件：FILE_ONLY
该目录、子目录及文件: FOLDER_FILE

setAssignedPermissionByGroup

void setAssignedPermissionByGroup(java.lang.String resId,
                                  java.lang.String groupId,
                                  java.lang.String type,
                                  boolean inherited,
                                  java.lang.String permissionDescendType,
                                  boolean isGroupDescend)

设置该资源的组权限

参数:

resId - 资源ID

groupId - 组ID

type - 权限类型，有以下四种：
引用权限：REF
查看权限：READ
编辑权限：WRITE
管理权限：ALL

inherited - 是否允许父项的继承权限传播到该对象和所有子对象

permissionDescendType - 权限应用范围，有以下几种：
只有该目录：NONE
该目录及子目录：FOLDER_ONLY
该目录及文件：FILE_ONLY
该目录、子目录及文件: FOLDER_FILE

isGroupDescend - 是否应用于子组

isCatalogElementAccessible

boolean isCatalogElementAccessible(java.lang.String id,
                                   java.lang.String type)

判断某个资源是否可访问。

参数:

id - 资源ID

type - 访问类型READ,WRITE,REF

返回:

isCatalogElementAccessible

createCatalogElement

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
4.灵活分析:SIMPLE_REPORT
5.指标类报表:METRIC_REPORT
6.复杂报表: FREE_REPORT
7.分析报表: BI3OLAP_REPORT
8.仪表分析: Dashboard
9.地图分析: DashboardMap
10.portal页面: PAGE
11.WEB链接：URL

返回:

资源对象

getCatalogElementByType

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
4.灵活分析:SIMPLE_REPORT
5.指标类报表:METRIC_REPORT
6.复杂报表: FREE_REPORT
7.分析报表: BI3OLAP_REPORT
8.仪表分析: Dashboard
9.地图分析: DashboardMap
10.portal页面: PAGE
11.WEB链接：URL

返回:

资源对象列表

copyAndPaste

java.lang.String copyAndPaste(java.lang.String toId,
                              java.lang.String srcId,
                              java.lang.String name,
                              java.lang.String alias,
                              java.lang.String desc)

将指定的资源复制到其它目录下，并重命名，然后返回复制后的资源ID。

参数:

toId - 目标文件夹的ID。

srcId - 被复制的资源ID。

name - 复制后的资源名称。

alias - 复制后的资源别名。

desc - 复制后的资源描述。

返回:

复制后的资源ID值。

setOwner

void setOwner(java.lang.String nodeId,
              java.lang.String ownerId,
              AssigneeType ownerType)

设置指定资源的所有者，可以将所有者设置为用户、用户组、或者角色。

参数:

nodeId - 待设置资源的ID。

ownerId - 所有者的ID。

ownerType - 所有者的类型：USER, ROLE, GROUP。