com.sap.netweaver.coll.wiki.api

Interface IWikiPermissionManager

public interface IWikiPermissionManager

Entry point for managing permissions in the wiki application.

Method Summary

void	addCommunityPermissionToAnonymousUser(long permission, boolean additive, long communityID) Adds community permission to anonymous user
void	addCommunityPermissionToGroup(long permission, boolean additive, String groupID, long communityID) Adds community permission to group
void	addCommunityPermissionToRegisteredUser(long permission, boolean additive, long communityID) Adds community permission to registered users
void	addCommunityPermissionToUser(long permission, boolean additive, String userID, long communityID) Adds community permission to user.
void	addDocumentPermissionToAnonymousUser(long permission, boolean additive, long documentID) Adds document permission to anonymous user
void	addDocumentPermissionToGroup(long permission, boolean additive, String groupID, long documentID) Adds document permissions to group
void	addDocumentPermissionToRegisteredUser(long permission, boolean additive, long documentID) Adds document permission to registered user
void	addDocumentPermissionToRole(long permission, boolean additive, String roleID, long documentID) Adds document permission to role
void	addDocumentPermissionToUser(long permission, boolean additive, String userID, long documentID) Adds document 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[]	allGroupsWithInheritedPermissionOnCommunity(long permission, boolean additive, long communityID) Returns all groups with inherited permission on community
String[]	allGroupsWithInheritedPermissionOnDocument(long permission, boolean additive, long documentID) Returns all groups with inherited permission on document
String[]	allUsersWithInheritedPermissionOnCommunity(long permission, boolean additive, long communityID) Returns all users with inherited permissions on community
String[]	allUsersWithInheritedPermissionOnDocument(long permission, boolean additive, long documentID) Returns all usrs with inherited permission on document
boolean	anonymousUserHasInheritedPermissionOnCommunity(long permission, boolean additive, long communityID) Checks if anonymous user inherited has permission on community
boolean	anonymousUserHasInheritedPermissionOnDocument(long permission, boolean additive, long documentID) Checks if anonymous user has inherited permission on document
boolean	anonymousUserHasPermission(long permission, boolean additive) Checks if anonymous user has permission
boolean	anonymousUserHasPermissionOnCommunity(long permission, boolean additive, long communityID) Checks if anonymous user has permission on community
boolean	anonymousUserHasPermissionOnDocument(long permission, boolean additive, long documentID) Checks if anonymous user has permission on document
String[]	groupsWithPermission(long permission, boolean additive) Returns all groups with specific permission
String[]	groupsWithPermissionOnCommunity(long permission, boolean additive, long communityID) Returns group with specific permission on community
String[]	groupsWithPermissionOnDocument(long permission, boolean additive, long documentID) Returns groups with specific permission on document
boolean	isAuthorized(long permission) Checks if context user is authorised a permission.
boolean	isAuthorizedOnCommunity(long permission, long communityID) Checks if context user is authorised a permission on community
boolean	isAuthorizedOnDocument(long permission, long documentID) Checks if context user is authorised a permission on document
boolean	isUserAuthorized(long permission, String userID) Checks if users is authorised a permission
boolean	isUserAuthorizedOnCommunity(long permission, String userID, long communityID) Checks if user is authorised specific permission on community
boolean	isUserAuthorizedOnDocument(long permission, String userID, long documentID) Checks if users is authorised specific permission on document
boolean	registeredUserHasInheritedPermissionOnCommunity(long permission, boolean additive, long communityID) Checks if registered user has inherited permission on community
boolean	registeredUserHasInheritedPermissionOnDocument(long permission, boolean additive, long documentID) Checks if registered user has inherited permission on document
boolean	registeredUserHasPermission(long permission, boolean additive) Checks if registered user has permission
boolean	registeredUserHasPermissionOnCommunity(long permission, boolean additive, long communityID) Checks if registered user has permission on community
boolean	registeredUserHasPermissionOnDocument(long permission, boolean additive, long documentID) Checks if registered user has permission on document
void	removeCommunityPermissionFromGroup(long permission, boolean additive, String groupID, long communityID) Removes community permission of group
void	removeCommunityPermissionFromUser(long permission, boolean additive, String userID, long communityID) Removes community permission from user
void	removeDocumentPermissionFromGroup(long permission, boolean additive, String groupID, long documentID) Removes document permision of group
void	removeDocumentPermissionFromRole(long permission, boolean additive, String roleID, long documentID) Removes document permission from role
void	removeDocumentPermissionFromUser(long permission, boolean additive, String userID, long documentID) Removes document permission from 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) Unique names of users with specific permission
int	usersWithPermissionCount(long permission, boolean additive) Number of users with specific permissions
int	usersWithPermissionCountOnCommunity(long permission, boolean additive, long communityID) Number of users with specific permission on community
int	usersWithPermissionCountOnDocument(long permission, boolean additive, long documentID) Number of users with specific permission on document
String[]	usersWithPermissionOnCommunity(long permission, boolean additive, long communityID) Unique names of users with specific permissions on community
String[]	usersWithPermissionOnDocument(long permission, boolean additive, long documentID) Unique names of users with specific permission on document

Method Detail

addPermissionToUser

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

Adds permission to user.

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removePermissionFromUser

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

Removes permission of user

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addPermissionToGroup

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

Adds permission to group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique name

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removePermissionFromGroup

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

Removes permission of group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique name

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addDocumentPermissionToUser

void addDocumentPermissionToUser(long permission,
                                 boolean additive,
                                 String userID,
                                 long documentID)
                                 throws com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                        com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds document permission to user

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

documentID - the document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removeDocumentPermissionFromUser

void removeDocumentPermissionFromUser(long permission,
                                      boolean additive,
                                      String userID,
                                      long documentID)
                                      throws com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                             com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Removes document permission from user

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

documentID - the document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addCommunityPermissionToUser

void addCommunityPermissionToUser(long permission,
                                  boolean additive,
                                  String userID,
                                  long communityID)
                                  throws com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                         com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds community permission to user.

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

communityID - the community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removeCommunityPermissionFromUser

void removeCommunityPermissionFromUser(long permission,
                                       boolean additive,
                                       String userID,
                                       long communityID)
                                       throws com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Removes community permission from user

Parameters:

permission - the permission

additive - whether the permission is additive

userID - user unique name

communityID - the community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

isAuthorized

boolean isAuthorized(long permission)

Checks if context user is authorised a permission.

Parameters:

permission -

Returns:

true if context user is authorised

isAuthorizedOnDocument

boolean isAuthorizedOnDocument(long permission,
                               long documentID)
                               throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Checks if context user is authorised a permission on document

Parameters:

permission - the permission

documentID - document unique identifier

Returns:

true if context user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

isAuthorizedOnCommunity

boolean isAuthorizedOnCommunity(long permission,
                                long communityID)
                                throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

Checks if context user is authorised a permission on community

Parameters:

permission - the permission

communityID - the community unique identifier

Returns:

true if context user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

registeredUserHasPermission

boolean registeredUserHasPermission(long permission,
                                    boolean additive)
                                    throws com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if registered user has permission

Parameters:

permission - the permission

additive - whether the permission is additive

Returns:

true if registered user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

registeredUserHasPermissionOnDocument

boolean registeredUserHasPermissionOnDocument(long permission,
                                              boolean additive,
                                              long documentID)
                                              throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                                     com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if registered user has permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

true if registered user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

registeredUserHasPermissionOnCommunity

boolean registeredUserHasPermissionOnCommunity(long permission,
                                               boolean additive,
                                               long communityID)
                                               throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                      com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if registered user has permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

true if registered user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

anonymousUserHasPermission

boolean anonymousUserHasPermission(long permission,
                                   boolean additive)

Checks if anonymous user has permission

Parameters:

permission - the permission

additive - whether the permission is additive

Returns:

true if anonymous user has it

anonymousUserHasPermissionOnDocument

boolean anonymousUserHasPermissionOnDocument(long permission,
                                             boolean additive,
                                             long documentID)
                                             throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Checks if anonymous user has permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

true if anonymous user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

anonymousUserHasPermissionOnCommunity

boolean anonymousUserHasPermissionOnCommunity(long permission,
                                              boolean additive,
                                              long communityID)
                                              throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

Checks if anonymous user has permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

true if anonymous user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

usersWithPermissionCount

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

Number of users with specific permissions

Parameters:

permission - the permission

additive - whether the permission is additive

Returns:

count of users

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

usersWithPermission

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

Unique names of users with specific permission

Parameters:

permission - the permission

additive - whether the permission is additive

Returns:

array of user names

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

usersWithPermissionCountOnDocument

int usersWithPermissionCountOnDocument(long permission,
                                       boolean additive,
                                       long documentID)
                                       throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Number of users with specific permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

count of users

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

usersWithPermissionOnDocument

String[] usersWithPermissionOnDocument(long permission,
                                       boolean additive,
                                       long documentID)
                                       throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Unique names of users with specific permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

usersWithPermissionCountOnCommunity

int usersWithPermissionCountOnCommunity(long permission,
                                        boolean additive,
                                        long communityID)
                                        throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                               com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Number of users with specific permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

count of users

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

usersWithPermissionOnCommunity

String[] usersWithPermissionOnCommunity(long permission,
                                        boolean additive,
                                        long communityID)
                                        throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                               com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Unique names of users with specific permissions on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removeCommunityPermissionFromGroup

void removeCommunityPermissionFromGroup(long permission,
                                        boolean additive,
                                        String groupID,
                                        long communityID)
                                        throws com.sap.netweaver.coll.wiki.exception.GroupNotFoundException,
                                               com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Removes community permission of group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique identifier

communityID - community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addDocumentPermissionToGroup

void addDocumentPermissionToGroup(long permission,
                                  boolean additive,
                                  String groupID,
                                  long documentID)
                                  throws com.sap.netweaver.coll.wiki.exception.GroupNotFoundException,
                                         com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds document permissions to group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique identifier

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removeDocumentPermissionFromGroup

void removeDocumentPermissionFromGroup(long permission,
                                       boolean additive,
                                       String groupID,
                                       long documentID)
                                       throws com.sap.netweaver.coll.wiki.exception.GroupNotFoundException,
                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Removes document permision of group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique identifier

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addCommunityPermissionToGroup

void addCommunityPermissionToGroup(long permission,
                                   boolean additive,
                                   String groupID,
                                   long communityID)
                                   throws com.sap.netweaver.coll.wiki.exception.GroupNotFoundException,
                                          com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds community permission to group

Parameters:

permission - the permission

additive - whether the permission is additive

groupID - group unique identifier

communityID - community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.GroupNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

isUserAuthorized

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

Checks if users is authorised a permission

Parameters:

permission - the permission

userID - user unique name

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

isUserAuthorizedOnCommunity

boolean isUserAuthorizedOnCommunity(long permission,
                                    String userID,
                                    long communityID)
                                    throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                           com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                           com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if user is authorised specific permission on community

Parameters:

permission - the permission

userID - user unique name

communityID - community unique identifier

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

isUserAuthorizedOnDocument

boolean isUserAuthorizedOnDocument(long permission,
                                   String userID,
                                   long documentID)
                                   throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                          com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                                          com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if users is authorised specific permission on document

Parameters:

permission - the permission

userID - user unique name

documentID - document unique identifier

Returns:

true if user is authorised

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addDocumentPermissionToRole

void addDocumentPermissionToRole(long permission,
                                 boolean additive,
                                 String roleID,
                                 long documentID)
                                 throws com.sap.netweaver.coll.wiki.exception.RoleNotFoundException,
                                        com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds document permission to role

Parameters:

permission - the permission

additive - whether the permission is additive

roleID - role unique name

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.RoleNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

removeDocumentPermissionFromRole

void removeDocumentPermissionFromRole(long permission,
                                      boolean additive,
                                      String roleID,
                                      long documentID)
                                      throws com.sap.netweaver.coll.wiki.exception.RoleNotFoundException,
                                             com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Removes document permission from role

Parameters:

permission - the permission

additive - whether the permission is additive

roleID - role unique name

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.RoleNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

groupsWithPermission

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

Returns all groups with specific permission

Parameters:

permission - the permission

additive - whether the permission is additive

Returns:

array of group unique names

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

groupsWithPermissionOnDocument

String[] groupsWithPermissionOnDocument(long permission,
                                        boolean additive,
                                        long documentID)
                                        throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                               com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns groups with specific permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

array of group unique names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

groupsWithPermissionOnCommunity

String[] groupsWithPermissionOnCommunity(long permission,
                                         boolean additive,
                                         long communityID)
                                         throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns group with specific permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

array of group unique names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

allGroupsWithInheritedPermissionOnCommunity

String[] allGroupsWithInheritedPermissionOnCommunity(long permission,
                                                     boolean additive,
                                                     long communityID)
                                                     throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                            com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns all groups with inherited permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

allUsersWithInheritedPermissionOnCommunity

String[] allUsersWithInheritedPermissionOnCommunity(long permission,
                                                    boolean additive,
                                                    long communityID)
                                                    throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                           com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns all users with inherited permissions on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

allGroupsWithInheritedPermissionOnDocument

String[] allGroupsWithInheritedPermissionOnDocument(long permission,
                                                    boolean additive,
                                                    long documentID)
                                                    throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                                           com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns all groups with inherited permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

array of group names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

allUsersWithInheritedPermissionOnDocument

String[] allUsersWithInheritedPermissionOnDocument(long permission,
                                                   boolean additive,
                                                   long documentID)
                                                   throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                                          com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Returns all usrs with inherited permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

array of user names

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

anonymousUserHasInheritedPermissionOnDocument

boolean anonymousUserHasInheritedPermissionOnDocument(long permission,
                                                      boolean additive,
                                                      long documentID)
                                                      throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                                             com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if anonymous user has inherited permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

true if anonymous user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

anonymousUserHasInheritedPermissionOnCommunity

boolean anonymousUserHasInheritedPermissionOnCommunity(long permission,
                                                       boolean additive,
                                                       long communityID)
                                                       throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if anonymous user inherited has permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

true if anonymous user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

registeredUserHasInheritedPermissionOnDocument

boolean registeredUserHasInheritedPermissionOnDocument(long permission,
                                                       boolean additive,
                                                       long documentID)
                                                       throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                                              com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if registered user has inherited permission on document

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Returns:

true if registered user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

registeredUserHasInheritedPermissionOnCommunity

boolean registeredUserHasInheritedPermissionOnCommunity(long permission,
                                                        boolean additive,
                                                        long communityID)
                                                        throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                                                               com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Checks if registered user has inherited permission on community

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Returns:

true if registered user has it

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addPermissionToRegisteredUser

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

Adds permission to registered user

Parameters:

permission - the permission

additive - whether the permission is additive

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addCommunityPermissionToRegisteredUser

void addCommunityPermissionToRegisteredUser(long permission,
                                            boolean additive,
                                            long communityID)
                                            throws com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds community permission to registered users

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addDocumentPermissionToRegisteredUser

void addDocumentPermissionToRegisteredUser(long permission,
                                           boolean additive,
                                           long documentID)
                                           throws com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds document permission to registered user

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addPermissionToAnonymousUser

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

Adds permission to anonymous user

Parameters:

permission - the permission

additive - whether the permission is additive

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addCommunityPermissionToAnonymousUser

void addCommunityPermissionToAnonymousUser(long permission,
                                           boolean additive,
                                           long communityID)
                                           throws com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds community permission to anonymous user

Parameters:

permission - the permission

additive - whether the permission is additive

communityID - community unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

addDocumentPermissionToAnonymousUser

void addDocumentPermissionToAnonymousUser(long permission,
                                          boolean additive,
                                          long documentID)
                                          throws com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Adds document permission to anonymous user

Parameters:

permission - the permission

additive - whether the permission is additive

documentID - document unique identifier

Throws:

com.sap.netweaver.coll.wiki.exception.UnauthorizedException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[com.sap] KMC-WIKI	[com.sap] com.sap.netweaver.coll.wiki.api	api	BC-COM-WIK