Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Class PermissionType

java.lang.Object
  extended by com.jivesoftware.base.PermissionType

public class PermissionType
extends java.lang.Object

A class to represent the two modes of permissions - additive and negative. Additive permissions are permissions that should be 'added' to the permissions retrieved from a parent object(s), while negative permissions are permissions that permission should be ' revoked' or 'removed' from permissions retrieved from parent object(s).


Field Summary
static PermissionType ADDITIVE
          The additive permission type indicates that the permission should be 'added' to the permissions retrieved from a parent object(s).
static PermissionType NEGATIVE
          The negative permission type indicates that the permission should be 'revoked' or 'removed' from permissions retrieved from parent object(s).
 
Method Summary
 boolean equals(java.lang.Object object)
           
 int getID()
          Returns the id of the PermissionType
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ADDITIVE

public static final PermissionType ADDITIVE
The additive permission type indicates that 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.

As an example, setting an 'additive' permission to read forums for a category will cause that permission to be inherited by all child categories and forums such that the final permissions for child categories and forums will be the global permissions, plus parent category permissions (recursively up the category tree) plus the individual category and forum specific permissions.


NEGATIVE

public static final PermissionType NEGATIVE
The negative permission type indicates that the permission should be 'revoked' or 'removed' from permissions retrieved from parent object(s). This means that if the permission has been already set in a parent object that permission will be removed and will not be inherited for the object for which permissions are being set upon.

As an example, setting a 'negative' permission to read forums for a category will cause that permission to be removed from permissions inherited from parent categories and the global permissions. Thus that permission will no longer be inherited by all child categories and forums such that the final permissions for that category and all child categories and forums will not include the specified permission.

Method Detail

getID

public int getID()
Returns the id of the PermissionType

Returns:
the id of the PermissionType.

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.