com.filenet.wcm.apps.server.util
Class AccessRoles.Role

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.AccessRoles.Role
All Implemented Interfaces:
java.lang.Comparable
Enclosing class:
AccessRoles

public class AccessRoles.Role
extends java.lang.Object
implements java.lang.Comparable

Represents Access Role object


Method Summary
 void addAuthenticatedUsers()
          Adds #AUTHENTICATED-USERS as a member
 void addGrantee(com.filenet.wcm.toolkit.util.security.GranteeRef newGrantee)
          Adds a member
 int compareTo(java.lang.Object o)
          This method is used to sort role lists
 void delete()
          Delets the role
 int getAccessMask()
          Retursn access mask integer for the securedObject;
 java.lang.String getDescription()
          Returns role description
 com.filenet.wcm.toolkit.util.security.GranteeRef getGrantee(java.lang.String granteeId)
          Returns GrateeRef object based by granteeId
 java.lang.String getId()
          Returns Role id.
 java.util.List getMembers()
          Returns List of GranteeRef objects
 java.lang.String getName()
          Returns visible role name
 java.lang.String getType()
          return role's type back.
 boolean isAdminRole()
          Returns true if this role is an admin role.
 boolean isModified()
          Returns true if this role has been modified and not saved
 boolean isSystemRole()
          Returns true if the role is a system role
 boolean isTemporary()
           
 boolean isToBeDeleted()
           
 void refresh()
          Refreshes role members
 void removeGrantee(java.lang.String granteeId)
          Removes a member
 void setModified(boolean value)
          Sets the modified flag
 void setNameAndDescription(java.lang.String name, java.lang.String description)
          Sets role name and description
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAccessMask

public int getAccessMask()
Retursn access mask integer for the securedObject;

Returns:
access mask

getType

public java.lang.String getType()
return role's type back.

Returns:
type

isAdminRole

public boolean isAdminRole()
Returns true if this role is an admin role.


isModified

public boolean isModified()
Returns true if this role has been modified and not saved


isTemporary

public boolean isTemporary()

setModified

public void setModified(boolean value)
Sets the modified flag

Parameters:
value -

delete

public void delete()
Delets the role


refresh

public void refresh()
             throws java.lang.Exception
Refreshes role members

Throws:
java.lang.Exception

getName

public java.lang.String getName()
Returns visible role name


getDescription

public java.lang.String getDescription()
Returns role description


isSystemRole

public boolean isSystemRole()
Returns true if the role is a system role


isToBeDeleted

public boolean isToBeDeleted()

setNameAndDescription

public void setNameAndDescription(java.lang.String name,
                                  java.lang.String description)
Sets role name and description


getId

public java.lang.String getId()
Returns Role id. This is the id of the secured object.


getMembers

public java.util.List getMembers()
                          throws java.lang.Exception
Returns List of GranteeRef objects

Returns:
Throws:
java.lang.Exception

addGrantee

public void addGrantee(com.filenet.wcm.toolkit.util.security.GranteeRef newGrantee)
                throws java.lang.Exception
Adds a member

Parameters:
newGrantee -
Throws:
java.lang.Exception

addAuthenticatedUsers

public void addAuthenticatedUsers()
                           throws java.lang.Exception
Adds #AUTHENTICATED-USERS as a member

Throws:
java.lang.Exception

getGrantee

public com.filenet.wcm.toolkit.util.security.GranteeRef getGrantee(java.lang.String granteeId)
Returns GrateeRef object based by granteeId

Parameters:
granteeId -
Returns:
GrateeRef object

removeGrantee

public void removeGrantee(java.lang.String granteeId)
Removes a member

Parameters:
granteeId -

compareTo

public int compareTo(java.lang.Object o)
This method is used to sort role lists

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
o - another Role object. If o is not a Role, this method returns 0.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.