com.sap.netweaver.coll.forums.api

Interface IForumPermissionManager

public interface IForumPermissionManager

Entry point for managing permissions in the forums application.

See Also:

IForumPermission

Method Summary

void	addCategoryPermissionToAnonymousUser(long permission, boolean additive, long categoryID) Adds category permission to anonymous user
void	addCategoryPermissionToGroup(long permission, boolean additive, String groupID, long categoryID) Adds category permission to group
void	addCategoryPermissionToRegisteredUser(long permission, boolean additive, long categoryID) Adds category permission to registered user
void	addCategoryPermissionToUser(long permission, boolean additive, String userID, long categoryID) Adds category permission to user
void	addForumPermissionToAnonymousUser(long permission, boolean additive, long forumID) Adds forum permission to anonymous user
void	addForumPermissionToGroup(long permission, boolean additive, String groupID, long forumID) Adds forum permission to group
void	addForumPermissionToRegisteredUser(long permission, boolean additive, long forumID) Adds forum permission to registered user
void	addForumPermissionToRole(long permission, boolean additive, String roleID, long forumID) Adds forum permission to role
void	addForumPermissionToUser(long permission, boolean additive, String userID, long forumID) Adds forum permission to user
void	addPermissionToAnonymousUser(long permission, boolean additive) Adds permission to anonymous user
void	addPermissionToGroup(long permission, boolean additive, String groupID) Adds permission to group
void	addPermissionToRegisteredUser(long permission, boolean additive) Adds permission to registered user
void	addPermissionToUser(long permission, boolean additive, String userID) Adds permission to user
String[]	allGroupsWithInheritedPermissionOnCategory(long permission, boolean additive, long categoryID) Retrieves all groups with inherited permission on category
String[]	allGroupsWithInheritedPermissionOnForum(long permission, boolean additive, long forumID) Retrieves all groups with inherited permission on forum
String[]	allUsersWithInheritedPermissionOnCategory(long permission, boolean additive, long categoryID) Retrieves all users with inherited permission on category
String[]	allUsersWithInheritedPermissionOnForum(long permission, boolean additive, long forumID) Retrieves all users with inherited permission on forum
boolean	anonymousUserHasInheritedPermissionOnCategory(long permission, boolean additive, long categoryID) Checks if anonymous user has inherited permission on category
boolean	anonymousUserHasInheritedPermissionOnForum(long permission, boolean additive, long forumID) Checks if anonymous user has permission of forum
boolean	anonymousUserHasPermission(long permission, boolean additive) Checks if anonymous user has permission
boolean	anonymousUserHasPermissionOnCategory(long permission, boolean additive, long categoryID) Checks if anonymous user has permission on category
boolean	anonymousUserHasPermissionOnForum(long permission, boolean additive, long forumID) Checks if anonymous user has permission on forum
String[]	groupsWithPermission(long permission, boolean additive) Retrieves groups with permission
String[]	groupsWithPermissionOnCategory(long permission, boolean additive, long categoryID) Retrieves groups with permission on category
String[]	groupsWithPermissionOnForum(long permission, boolean additive, long forumID) Retrieves groups with permission on forums
boolean	isAuthorized(long permission) Checks if context user is authorised to given permission.
boolean	isAuthorizedOnCategory(long permission, long categoryID) Checks if context user is authorised on category
boolean	isAuthorizedOnForum(long permission, long forumID) Checks if context user is authorised on forum
boolean	isUserAuthorized(long permission, String userID) Checks if user is authorised
boolean	isUserAuthorizedOnCategory(long permission, String userID, long categoryID) Checks if user is authorised on category
boolean	isUserAuthorizedOnForum(long permission, String userID, long forumID) Checks if user is authorised on forum
boolean	registeredUserHasInheritedPermissionOnCategory(long permission, boolean additive, long categoryID) Checks if registered user has inherited permission on category
boolean	registeredUserHasInheritedPermissionOnForum(long permission, boolean additive, long forumID) Checks if registered user has inherited permission on forum
boolean	registeredUserHasPermission(long permission, boolean additive) Checks if registered user has permission
boolean	registeredUserHasPermissionOnCategory(long permission, boolean additive, long categoryID) Checks if registered user has permission on category
boolean	registeredUserHasPermissionOnForum(long permission, boolean additive, long forumID) Checks if registered user has permission on forum
void	removeCategoryPermissionFromGroup(long permission, boolean additive, String groupID, long categoryID) Removes category permission from group
void	removeCategoryPermissionFromUser(long permission, boolean additive, String userID, long categoryID) Adds category permission to user
void	removeForumPermissionFromGroup(long permission, boolean additive, String groupID, long forumID) Removes forum permission from group
void	removeForumPermissionFromRole(long permission, boolean additive, String roleID, long forumID) Removes forum permission from role
void	removeForumPermissionFromUser(long permission, boolean additive, String userID, long forumID) Removes forum permission of user
void	removePermissionFromGroup(long permission, boolean additive, String groupID) Removes permission of group
void	removePermissionFromUser(long permission, boolean additive, String userID) Removes permission of user
String[]	usersWithPermission(long permission, boolean additive) Returns user names of users with permission
int	usersWithPermissionCount(long permission, boolean additive) Returns the users with specified permission
int	usersWithPermissionCountOnCategory(long permission, boolean additive, long categoryID) Returns the count of users with permission on category
int	usersWithPermissionCountOnForum(long permission, boolean additive, long forumID) Returns the count of users with permission of forum
String[]	usersWithPermissionOnCategory(long permission, boolean additive, long categoryID) Returns the user names of users with permissions on category
String[]	usersWithPermissionOnForum(long permission, boolean additive, long forumID) Returns the user names of users with permission on forum

Method Detail

addPermissionToUser

void addPermissionToUser(long permission,
                         boolean additive,
                         String userID)
                         throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds permission to user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removePermissionFromUser

void removePermissionFromUser(long permission,
                              boolean additive,
                              String userID)
                              throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                     com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes permission of user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addPermissionToGroup

void addPermissionToGroup(long permission,
                          boolean additive,
                          String groupID)
                          throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                 com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds permission to group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removePermissionFromGroup

void removePermissionFromGroup(long permission,
                               boolean additive,
                               String groupID)
                               throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                      com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes permission of group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addForumPermissionToUser

void addForumPermissionToUser(long permission,
                              boolean additive,
                              String userID,
                              long forumID)
                              throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                     com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds forum permission to user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removeForumPermissionFromUser

void removeForumPermissionFromUser(long permission,
                                   boolean additive,
                                   String userID,
                                   long forumID)
                                   throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                          com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes forum permission of user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addCategoryPermissionToUser

void addCategoryPermissionToUser(long permission,
                                 boolean additive,
                                 String userID,
                                 long categoryID)
                                 throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                        com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds category permission to user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

categoryID - the category unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removeCategoryPermissionFromUser

void removeCategoryPermissionFromUser(long permission,
                                      boolean additive,
                                      String userID,
                                      long categoryID)
                                      throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                             com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds category permission to user

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

userID - the user name

categoryID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

isAuthorized

boolean isAuthorized(long permission)

Checks if context user is authorised to given permission.

Parameters:

permission - the permission

Returns:

true if context user is authorised

isAuthorizedOnForum

boolean isAuthorizedOnForum(long permission,
                            long forumID)
                            throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

Checks if context user is authorised on forum

Parameters:

permission - the permission

forumID - the forum unique identifier

Returns:

true if context user is authorised

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

isAuthorizedOnCategory

boolean isAuthorizedOnCategory(long permission,
                               long categoryID)
                               throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Checks if context user is authorised on category

Parameters:

permission - the permission

categoryID - the category unique identifier

Returns:

true if context user is authorised

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

registeredUserHasPermission

boolean registeredUserHasPermission(long permission,
                                    boolean additive)
                                    throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if registered user has permission

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

Returns:

true if registered users are authorised the permission

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

registeredUserHasPermissionOnForum

boolean registeredUserHasPermissionOnForum(long permission,
                                           boolean additive,
                                           long forumID)
                                           throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                                  com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if registered user has permission on forum

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

true if registered users are authorised the permission

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

registeredUserHasPermissionOnCategory

boolean registeredUserHasPermissionOnCategory(long permission,
                                              boolean additive,
                                              long categoryID)
                                              throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                                     com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if registered user has permission on category

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

true if registered users are authorised the permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

anonymousUserHasPermission

boolean anonymousUserHasPermission(long permission,
                                   boolean additive)

Checks if anonymous user has permission

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

Returns:

true if anonymous users are authorised the permission

anonymousUserHasPermissionOnForum

boolean anonymousUserHasPermissionOnForum(long permission,
                                          boolean additive,
                                          long forumID)
                                          throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

Checks if anonymous user has permission on forum

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

true if anonymous users are authorised the permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

anonymousUserHasPermissionOnCategory

boolean anonymousUserHasPermissionOnCategory(long permission,
                                             boolean additive,
                                             long categoryID)
                                             throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Checks if anonymous user has permission on category

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

true if anonymous users are authorised the permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

usersWithPermissionCount

int usersWithPermissionCount(long permission,
                             boolean additive)
                             throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns the users with specified permission

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

Returns:

the count of users

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

usersWithPermission

String[] usersWithPermission(long permission,
                             boolean additive)
                             throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns user names of users with permission

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

usersWithPermissionCountOnForum

int usersWithPermissionCountOnForum(long permission,
                                    boolean additive,
                                    long forumID)
                                    throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                           com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns the count of users with permission of forum

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

usersWithPermissionOnForum

String[] usersWithPermissionOnForum(long permission,
                                    boolean additive,
                                    long forumID)
                                    throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                           com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns the user names of users with permission on forum

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

the count of users

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

usersWithPermissionCountOnCategory

int usersWithPermissionCountOnCategory(long permission,
                                       boolean additive,
                                       long categoryID)
                                       throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                              com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns the count of users with permission on category

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

usersWithPermissionOnCategory

String[] usersWithPermissionOnCategory(long permission,
                                       boolean additive,
                                       long categoryID)
                                       throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                              com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Returns the user names of users with permissions on category

Parameters:

permission - the permission

additive - weather the user should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removeCategoryPermissionFromGroup

void removeCategoryPermissionFromGroup(long permission,
                                       boolean additive,
                                       String groupID,
                                       long categoryID)
                                       throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                              com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes category permission from group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

categoryID - the category unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addForumPermissionToGroup

void addForumPermissionToGroup(long permission,
                               boolean additive,
                               String groupID,
                               long forumID)
                               throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                      com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds forum permission to group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removeForumPermissionFromGroup

void removeForumPermissionFromGroup(long permission,
                                    boolean additive,
                                    String groupID,
                                    long forumID)
                                    throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                           com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes forum permission from group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addCategoryPermissionToGroup

void addCategoryPermissionToGroup(long permission,
                                  boolean additive,
                                  String groupID,
                                  long categoryID)
                                  throws com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException,
                                         com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds category permission to group

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

groupID - the group name

categoryID - the category unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.GroupNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

isUserAuthorized

boolean isUserAuthorized(long permission,
                         String userID)
                         throws com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if user is authorised

Parameters:

permission - the permission

userID - the user name

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

isUserAuthorizedOnCategory

boolean isUserAuthorizedOnCategory(long permission,
                                   String userID,
                                   long categoryID)
                                   throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                          com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                          com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if user is authorised on category

Parameters:

permission - the permission

userID - the user name

categoryID - the category unique identifier

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

isUserAuthorizedOnForum

boolean isUserAuthorizedOnForum(long permission,
                                String userID,
                                long forumID)
                                throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                       com.sap.netweaver.coll.forums.exceptions.UserNotFoundException,
                                       com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if user is authorised on forum

Parameters:

permission - the permission

userID - the user name

forumID - the forum unique identifier

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UserNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addForumPermissionToRole

void addForumPermissionToRole(long permission,
                              boolean additive,
                              String roleID,
                              long forumID)
                              throws com.sap.netweaver.coll.forums.exceptions.RoleNotFoundException,
                                     com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds forum permission to role

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

roleID - the role name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.RoleNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

removeForumPermissionFromRole

void removeForumPermissionFromRole(long permission,
                                   boolean additive,
                                   String roleID,
                                   long forumID)
                                   throws com.sap.netweaver.coll.forums.exceptions.RoleNotFoundException,
                                          com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Removes forum permission from role

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

roleID - the role name

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.RoleNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

groupsWithPermission

String[] groupsWithPermission(long permission,
                              boolean additive)
                              throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves groups with permission

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

Returns:

array of group names

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

groupsWithPermissionOnForum

String[] groupsWithPermissionOnForum(long permission,
                                     boolean additive,
                                     long forumID)
                                     throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                            com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves groups with permission on forums

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

groupsWithPermissionOnCategory

String[] groupsWithPermissionOnCategory(long permission,
                                        boolean additive,
                                        long categoryID)
                                        throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                               com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves groups with permission on category

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

allGroupsWithInheritedPermissionOnCategory

String[] allGroupsWithInheritedPermissionOnCategory(long permission,
                                                    boolean additive,
                                                    long categoryID)
                                                    throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                                           com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves all groups with inherited permission on category

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

allUsersWithInheritedPermissionOnCategory

String[] allUsersWithInheritedPermissionOnCategory(long permission,
                                                   boolean additive,
                                                   long categoryID)
                                                   throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                                          com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves all users with inherited permission on category

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

allGroupsWithInheritedPermissionOnForum

String[] allGroupsWithInheritedPermissionOnForum(long permission,
                                                 boolean additive,
                                                 long forumID)
                                                 throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                                        com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves all groups with inherited permission on forum

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

allUsersWithInheritedPermissionOnForum

String[] allUsersWithInheritedPermissionOnForum(long permission,
                                                boolean additive,
                                                long forumID)
                                                throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                                       com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Retrieves all users with inherited permission on forum

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

anonymousUserHasInheritedPermissionOnForum

boolean anonymousUserHasInheritedPermissionOnForum(long permission,
                                                   boolean additive,
                                                   long forumID)
                                                   throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                                          com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if anonymous user has permission of forum

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

true if anonymous user has permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

anonymousUserHasInheritedPermissionOnCategory

boolean anonymousUserHasInheritedPermissionOnCategory(long permission,
                                                      boolean additive,
                                                      long categoryID)
                                                      throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                                             com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if anonymous user has inherited permission on category

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

true if anonymous user has permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

registeredUserHasInheritedPermissionOnForum

boolean registeredUserHasInheritedPermissionOnForum(long permission,
                                                    boolean additive,
                                                    long forumID)
                                                    throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                                           com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if registered user has inherited permission on forum

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Returns:

true if registered user has permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

registeredUserHasInheritedPermissionOnCategory

boolean registeredUserHasInheritedPermissionOnCategory(long permission,
                                                       boolean additive,
                                                       long categoryID)
                                                       throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException,
                                                              com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Checks if registered user has inherited permission on category

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Returns:

true if registered user has permission

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addPermissionToRegisteredUser

void addPermissionToRegisteredUser(long permission,
                                   boolean additive)
                                   throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds permission to registered user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addCategoryPermissionToRegisteredUser

void addCategoryPermissionToRegisteredUser(long permission,
                                           boolean additive,
                                           long categoryID)
                                           throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds category permission to registered user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addForumPermissionToRegisteredUser

void addForumPermissionToRegisteredUser(long permission,
                                        boolean additive,
                                        long forumID)
                                        throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds forum permission to registered user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addPermissionToAnonymousUser

void addPermissionToAnonymousUser(long permission,
                                  boolean additive)
                                  throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds permission to anonymous user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addCategoryPermissionToAnonymousUser

void addCategoryPermissionToAnonymousUser(long permission,
                                          boolean additive,
                                          long categoryID)
                                          throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds category permission to anonymous user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

categoryID - the category unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

addForumPermissionToAnonymousUser

void addForumPermissionToAnonymousUser(long permission,
                                       boolean additive,
                                       long forumID)
                                       throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

Adds forum permission to anonymous user

Parameters:

permission - the permission

additive - weather should be granted or revoked the specified permission

forumID - the forum unique identifier

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException