com.sap.workspaces.workspace

Interface ICategories

All Superinterfaces:

IWorkspacesService

public interface ICategories
extends IWorkspacesService

Provides access to the workspace categories that can be assigned to workspaces

Since:

1.1

Method Summary

ICategory[]	getCategories(com.sap.security.api.IUser user) Returns an array of all workspace categories defined in the system
String[]	getCategoriesInUse(Type[] workspaceTypes, PermissionPolicy[] permissionPolicies, Status[] statuses) Returns an array of IDs of the categories used in the workspaces that match the specified conditions
ICategory	getCategory(com.sap.security.api.IUser user, String categoryID) Returns the specified workspace category

Method Detail

getCategories

ICategory[] getCategories(com.sap.security.api.IUser user)
                          throws WorkspacesRuntimeException

Returns an array of all workspace categories defined in the system

Parameters:

user - the current user

Returns:

An array of all workspace categories defined in the system

Throws:

WorkspacesRuntimeException

getCategory

ICategory getCategory(com.sap.security.api.IUser user,
                      String categoryID)
                      throws WorkspacesRuntimeException

Returns the specified workspace category

Parameters:

user - the current user

categoryID - the ID of the category

Returns:

Returns the workspace category with the specified ID

Throws:

WorkspacesRuntimeException

getCategoriesInUse

String[] getCategoriesInUse(Type[] workspaceTypes,
                            PermissionPolicy[] permissionPolicies,
                            Status[] statuses)
                            throws WorkspacesRuntimeException

Returns an array of IDs of the categories used in the workspaces that match the specified conditions

Parameters:

workspaceTypes - an array of relevant workspace types, or null, which means all workspace types

permissionPolicies - an array of relevant permission policies, or null, which means all permission policies

statuses - relevant statuses of the workspaces, or null, which means all statuses

Returns:

An array of IDs of the categories used in the workspaces that match the specified conditions

Throws:

WorkspacesRuntimeException