|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PermissionService
Provides a webservice for managing permissions on users and groups.
Permissions
,
ForumPermissions
Method Summary | |
---|---|
void |
addAnonymousUserPermission(long permission,
boolean additive)
Add the specified permission to anonymous users. |
void |
addCategoryPermissionToAnonymousUser(long permission,
boolean additive,
long categoryID)
Add the specified permission on the specified category to anonymous users. |
void |
addCategoryPermissionToGroup(long permission,
boolean additive,
long groupID,
long categoryID)
Add the specified permission on the specified category to the group with the specified id. |
void |
addCategoryPermissionToRegisteredUser(long permission,
boolean additive,
long categoryID)
Add the specified permission on the specified category to registered users. |
void |
addCategoryPermissionToUser(long permission,
boolean additive,
long userID,
long categoryID)
Add the specified permission on the specified category to the user with the specified id. |
void |
addCategoryPermissionToUsers(long permission,
boolean additive,
long[] userIDs,
long categoryID)
Add the specified permission on the specified category to the specified users. |
void |
addForumPermissionToAnonymousUser(long permission,
boolean additive,
long forumID)
Add the specified permission on the specified forum to anonymous users. |
void |
addForumPermissionToGroup(long permission,
boolean additive,
long groupID,
long forumID)
Add the specified permission on the specified forum to the group with the specified id. |
void |
addForumPermissionToRegisteredUser(long permission,
boolean additive,
long forumID)
Remove the specified permission on the specified forum from registered users. |
void |
addForumPermissionToUser(long permission,
boolean additive,
long userID,
long forumID)
Add the specified permission on the specified forum to the user with the specified id. |
void |
addForumPermissionToUsers(long permission,
boolean additive,
long[] userIDs,
long forumID)
Add the specified permission on the specified forum to the specified users. |
void |
addPermissionToGroup(long permission,
boolean additive,
long groupID)
Add the specified permission to the group with the specified id. |
void |
addPermissionToUser(long permission,
boolean additive,
long userID)
Add the specified permission to the user with the specified id. |
void |
addPermissionToUsers(long permission,
boolean additive,
long[] userIDs)
Add the specified permission to all specified users. |
void |
addRegisteredUserPermission(long permission,
boolean additive)
Add the specified permission to registered users. |
boolean |
anonymousUserHasPermission(long permission,
boolean additive)
Returns true if the anonymous users have a particular permission globally. |
boolean |
anonymousUserHasPermissionOnCategory(long permission,
boolean additive,
long categoryID)
Returns true if the anonymous users have a particular permission on the category with the specified ID. |
boolean |
anonymousUserHasPermissionOnForum(long permission,
boolean additive,
long forumID)
Returns true if the anonymous users have a particular permission on the forum with the specified ID. |
long |
getPermissions()
Returns global permissions for current user. |
long |
getPermissionsOnCategory(long categoryID)
Returns permissions for current user on specified category. |
long |
getPermissionsOnForum(long forumID)
Returns permissions for current user on specified forum. |
long |
getUserPermissions(long userID)
Returns global permissions for specified user. |
long |
getUserPermissionsOnCategory(long userID,
long categoryID)
Returns permissions for specified user on specified category. |
long |
getUserPermissionsOnForum(long userID,
long forumID)
Returns permissions for specified user on specified forum. |
boolean |
isAuthorized(long permission)
Returns true if the current user has globally has the specified permission. |
boolean |
isAuthorizedOnCategory(long permission,
long categoryID)
Returns true if the current user has the permission specified on the specified category. |
boolean |
isAuthorizedOnForum(long permission,
long forumID)
Returns true if the current user has the permission specified on the specified forum. |
boolean |
isUserAuthorized(long permission,
long userID)
Checks to see if a particular user has a praticular permission system wide. |
boolean |
isUserAuthorizedOnCategory(long permission,
long userID,
long categoryID)
Checks to see if a particular user has a particular permission on the specified category. |
boolean |
isUserAuthorizedOnForum(long permission,
long userID,
long forumID)
Checks to see if a particular user has a particular permission on the specified forum. |
boolean |
registeredUserHasPermission(long permission,
boolean additive)
Returns true if registered users have a particular permission globally. |
boolean |
registeredUserHasPermissionOnCategory(long permission,
boolean additive,
long categoryID)
Returns true if registered users have a particular permission on the category with the specified ID. |
boolean |
registeredUserHasPermissionOnForum(long permission,
boolean additive,
long forumID)
Returns true if registered users have a particular permission on the forum with the specified ID. |
void |
removeAnonymousUserPermission(long permission,
boolean additive)
Remove the specified permission from anonymous users. |
void |
removeCategoryPermissionFromAnonymousUser(long permission,
boolean additive,
long categoryID)
Remove the specified permission on the specified category from anonymous users. |
void |
removeCategoryPermissionFromGroup(long permission,
boolean additive,
long groupID,
long categoryID)
Remove the specified permission on the specified category from the group with the specified id. |
void |
removeCategoryPermissionFromRegisteredUser(long permission,
boolean additive,
long categoryID)
Remove the specified permission on the specified category from registered users. |
void |
removeCategoryPermissionFromUser(long permission,
boolean additive,
long userID,
long categoryID)
Remove the specified permission on the specified category from the user with the specified id. |
void |
removeCategoryPermissionFromUsers(long permission,
boolean additive,
long[] userIDs,
long categoryID)
Remove the specified permission on the specified category from the specified users. |
void |
removeForumPermissionFromAnonymousUser(long permission,
boolean additive,
long forumID)
Remove the specified permission on the specified forum to anonymous users. |
void |
removeForumPermissionFromGroup(long permission,
boolean additive,
long groupID,
long forumID)
Remove the specified permission on the specified forum from the group with the specified id. |
void |
removeForumPermissionFromRegisteredUser(long permission,
boolean additive,
long forumID)
Remove the specified permission on the specified forum to registered users. |
void |
removeForumPermissionFromUser(long permission,
boolean additive,
long userID,
long forumID)
Remove the specified permission on the specified forum from the user with the specified id. |
void |
removeForumPermissionFromUsers(long permission,
boolean additive,
long[] userIDs,
long forumID)
Remove the specified permission on the specified forum from the specified users. |
void |
removePermissionFromGroup(long permission,
boolean additive,
long groupID)
Remove the specified permission from the group with the specified id. |
void |
removePermissionFromUser(long permission,
boolean additive,
long userID)
Remove the specified permission from the user with the specified id. |
void |
removePermissionFromUsers(long permission,
boolean additive,
long[] userIDs)
Remove the specified permission from all specified users. |
void |
removeRegisteredUserPermission(long permission,
boolean additive)
Remove the specified permission from registered users. |
long[] |
usersWithPermission(long permission,
boolean additive)
Returns all the userID's of users with a particular permission. |
int |
usersWithPermissionCount(long permission,
boolean additive)
Returns a count of the users that have a particular permission. |
int |
usersWithPermissionCountOnCategory(long permission,
boolean additive,
long categoryID)
Returns a count of the users that have a particular permission on the specified category. |
int |
usersWithPermissionCountOnForum(long permission,
boolean additive,
long forumID)
Returns a count of the users that have a particular permission on the specified forum. |
long[] |
usersWithPermissionOnCategory(long permission,
boolean additive,
long categoryID)
Returns all the userID's of users with a particular permission on the specified category. |
long[] |
usersWithPermissionOnForum(long permission,
boolean additive,
long forumID)
Returns all the userID's of users with a particular permission on the specified forum. |
Method Detail |
---|
void addPermissionToUser(long permission, boolean additive, long userID) throws UserNotFoundException
permission
- The permission to add to a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to add a permission too.
UserNotFoundException
void removePermissionFromUser(long permission, boolean additive, long userID) throws UserNotFoundException
permission
- The permission remove from a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to remove a permission from.
UserNotFoundException
void addPermissionToUsers(long permission, boolean additive, long[] userIDs) throws UserNotFoundException
permission
- The permission to add to the users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids to which permission will be added.
UserNotFoundException
void removePermissionFromUsers(long permission, boolean additive, long[] userIDs) throws UserNotFoundException
permission
- The permission to remove from the users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids from which permission will be removed.
UserNotFoundException
void addAnonymousUserPermission(long permission, boolean additive) throws UserNotFoundException
permission
- The permission to add to anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
UserNotFoundException
void removeAnonymousUserPermission(long permission, boolean additive) throws UserNotFoundException
permission
- The permission remove from anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
UserNotFoundException
void addRegisteredUserPermission(long permission, boolean additive) throws UserNotFoundException
permission
- The permission to add to registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
UserNotFoundException
void removeRegisteredUserPermission(long permission, boolean additive) throws UserNotFoundException
permission
- The permission remove from registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
UserNotFoundException
void addPermissionToGroup(long permission, boolean additive, long groupID) throws GroupNotFoundException
permission
- The permission to add to a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to add a permission too.
GroupNotFoundException
void removePermissionFromGroup(long permission, boolean additive, long groupID) throws GroupNotFoundException
permission
- The permission remove from a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to remove a permission from.
GroupNotFoundException
void addForumPermissionToUser(long permission, boolean additive, long userID, long forumID) throws UserNotFoundException
permission
- The permission to add to a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to add a permission too.forumID
- The ID of the forum to add the permission on
UserNotFoundException
void removeForumPermissionFromUser(long permission, boolean additive, long userID, long forumID) throws UserNotFoundException
permission
- The permission remove from a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to remove a permission from.forumID
- The ID of the forum to remove the permission from.
UserNotFoundException
void addForumPermissionToUsers(long permission, boolean additive, long[] userIDs, long forumID) throws UserNotFoundException
permission
- The permission to add to the users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids to which permission will be added.forumID
- The ID of the forum on which permission will be added.
UserNotFoundException
void removeForumPermissionFromUsers(long permission, boolean additive, long[] userIDs, long forumID) throws UserNotFoundException
permission
- The permission to remove from the users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids from which permission will be removed.forumID
- The ID of the forum on which permission will be removed.
UserNotFoundException
void addForumPermissionToAnonymousUser(long permission, boolean additive, long forumID)
permission
- The permission to add to anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to add the permission onvoid removeForumPermissionFromAnonymousUser(long permission, boolean additive, long forumID)
permission
- The permission remove from to anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to remove the permission from.void addForumPermissionToRegisteredUser(long permission, boolean additive, long forumID)
permission
- The permission remove from registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to remove the permission from.void removeForumPermissionFromRegisteredUser(long permission, boolean additive, long forumID)
permission
- The permission remove from to registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to remove the permission from.void addCategoryPermissionToUser(long permission, boolean additive, long userID, long categoryID) throws UserNotFoundException
permission
- The permission to add to a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to add a permission too.categoryID
- The ID of the category to add the permission on
UserNotFoundException
void removeCategoryPermissionFromUser(long permission, boolean additive, long userID, long categoryID) throws UserNotFoundException
permission
- The permission remove from a user.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userID
- The id of the user to remove a permission from.categoryID
- The ID of the category to remove the permission from.
UserNotFoundException
void addCategoryPermissionToUsers(long permission, boolean additive, long[] userIDs, long categoryID) throws UserNotFoundException
permission
- The permission to add to the users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids to which permission will be added.categoryID
- The ID of the category on which permission will be added.
UserNotFoundException
void removeCategoryPermissionFromUsers(long permission, boolean additive, long[] userIDs, long categoryID) throws UserNotFoundException
permission
- The permission to remove from users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.userIDs
- The user ids to which permission will be added.categoryID
- The ID of the category on which permission will be removed.
UserNotFoundException
void addCategoryPermissionToAnonymousUser(long permission, boolean additive, long categoryID)
permission
- The permission to add to anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to add the permission onvoid removeCategoryPermissionFromAnonymousUser(long permission, boolean additive, long categoryID)
permission
- The permission remove from anonymous users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to remove the permission from.void addCategoryPermissionToRegisteredUser(long permission, boolean additive, long categoryID)
permission
- The permission to add to registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to add the permission onvoid removeCategoryPermissionFromRegisteredUser(long permission, boolean additive, long categoryID)
permission
- The permission remove from registered users.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to remove the permission from.boolean isAuthorized(long permission)
permission
- a permission type.
boolean isAuthorizedOnForum(long permission, long forumID) throws ForumNotFoundException
permission
- a permission type.forumID
- to see if the current user has permission on.
ForumNotFoundException
boolean isAuthorizedOnCategory(long permission, long categoryID) throws ForumCategoryNotFoundException
permission
- a permission type.categoryID
- to see if the current user has permission on.
ForumCategoryNotFoundException
long getPermissions()
long getPermissionsOnForum(long forumID) throws ForumNotFoundException
forumID
- The id of the forum.
ForumNotFoundException
- If the specified forum does not exist.long getPermissionsOnCategory(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The id of the category.
ForumCategoryNotFoundException
- If the specified category does not exist.boolean registeredUserHasPermission(long permission, boolean additive)
permission
- The permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
boolean registeredUserHasPermissionOnForum(long permission, boolean additive, long forumID) throws UserNotFoundException, ForumNotFoundException
permission
- The permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to check the permission on.
UserNotFoundException
ForumNotFoundException
boolean registeredUserHasPermissionOnCategory(long permission, boolean additive, long categoryID) throws ForumCategoryNotFoundException
permission
- The permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to check the permission on.
ForumCategoryNotFoundException
boolean anonymousUserHasPermission(long permission, boolean additive)
permission
- The permission to see if anonymous users have this permission.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
boolean anonymousUserHasPermissionOnForum(long permission, boolean additive, long forumID) throws ForumNotFoundException
permission
- The permission to see if anonymous users have this permission on the specified forum.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to check to see if a user has permission on.
ForumNotFoundException
boolean anonymousUserHasPermissionOnCategory(long permission, boolean additive, long categoryID) throws ForumCategoryNotFoundException
permission
- The permission to see if anonymous users have this permission on the specified category.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to check to see if a user has permission on.
ForumCategoryNotFoundException
int usersWithPermissionCount(long permission, boolean additive)
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
long[] usersWithPermission(long permission, boolean additive)
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.
int usersWithPermissionCountOnForum(long permission, boolean additive, long forumID) throws ForumNotFoundException
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objectsforumID
- The id of the forum..
ForumNotFoundException
long[] usersWithPermissionOnForum(long permission, boolean additive, long forumID) throws ForumNotFoundException
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.forumID
- The ID of the forum to get users with the specified permission.
ForumNotFoundException
int usersWithPermissionCountOnCategory(long permission, boolean additive, long categoryID) throws ForumCategoryNotFoundException
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objectscategoryID
- The id of the category..
ForumCategoryNotFoundException
long[] usersWithPermissionOnCategory(long permission, boolean additive, long categoryID) throws ForumCategoryNotFoundException
permission
- the permission to check.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.categoryID
- The ID of the category to get users with the specified permission.
ForumCategoryNotFoundException
void removeCategoryPermissionFromGroup(long permission, boolean additive, long groupID, long categoryID) throws GroupNotFoundException
permission
- The permission remove from a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to remove a permission from.categoryID
- The ID of the category to remove the permission from.
GroupNotFoundException
void addForumPermissionToGroup(long permission, boolean additive, long groupID, long forumID) throws GroupNotFoundException
permission
- The permission to add to a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to add a permission too.forumID
- The ID of the forum to add the permission on
GroupNotFoundException
void removeForumPermissionFromGroup(long permission, boolean additive, long groupID, long forumID) throws GroupNotFoundException
permission
- The permission remove from a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to remove a permission from.forumID
- The ID of the forum to remove the permission from.
GroupNotFoundException
void addCategoryPermissionToGroup(long permission, boolean additive, long groupID, long categoryID) throws GroupNotFoundException
permission
- The permission to add to a group.additive
- True if the permission should be 'added' to the
permissions retrieved from a parent object(s). This means that if the permission
has been already set in a parent object, it will be inherited by all child objects.groupID
- The id of the group to add a permission too.categoryID
- The ID of the category to add the permission on
GroupNotFoundException
boolean isUserAuthorized(long permission, long userID)
permission
- The permission to check.userID
- The id of the user
boolean isUserAuthorizedOnCategory(long permission, long userID, long categoryID) throws ForumCategoryNotFoundException
permission
- The permission to check.userID
- The id of the user.categoryID
- The id of the category.
ForumCategoryNotFoundException
- If the specified category does not exist.boolean isUserAuthorizedOnForum(long permission, long userID, long forumID) throws ForumNotFoundException
permission
- The permission to check.userID
- The id of the user.forumID
- The id of the forum.
ForumNotFoundException
- If the specified form does not exist.long getUserPermissions(long userID)
userID
- The id of the user.
long getUserPermissionsOnCategory(long userID, long categoryID) throws ForumCategoryNotFoundException
userID
- The id of the user.categoryID
- The id of the category.
ForumCategoryNotFoundException
- If the specified category does not exist.long getUserPermissionsOnForum(long userID, long forumID) throws ForumNotFoundException
userID
- The id of the user.forumID
- The id of the forum.
ForumNotFoundException
- If the specified forum does not exist.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |