com.plumtree.server
Interface IPTAccessListEntry

All Superinterfaces:
IPTUnknown

public interface IPTAccessListEntry
extends IPTUnknown

An Access List describes the security attributes of a Plumtree Object. An Access List is a collection of Access List Entries. Each Access List Entry describes a level of access that has been assigned to a particular user or group.

Author:
michaels
See Also:
IPTAccessList

Method Summary
 int GetAccessLevel()
          Returns the access level as specified in PT_ACCESS_LEVELs.
 int GetClassID()
          Returns the classid of this ACL entry.
 java.lang.String GetName()
          GetName returns the name of the Group/User on this ACL entry.
 int GetObjectID()
          Returns the object id of this ACL entry.
 boolean GetReadOnly()
          Returns if this ACL entry is read only and therefore immutable.
 void SetAccessLevel(int Value)
          Sets the access level on this ACL entry.
 void SetName(java.lang.String Value)
          Sets the name of the group/user of the ACL
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetName

java.lang.String GetName()
GetName returns the name of the Group/User on this ACL entry.

Returns:
the name of the Group/User of this ACL entry.

SetName

void SetName(java.lang.String Value)
Sets the name of the group/user of the ACL

Parameters:
name - the name of the group/user

GetClassID

int GetClassID()
Returns the classid of this ACL entry. Can be PT_USERGROUP_ID or PT_USER_ID.

Returns:
the class id.
See Also:
PT_CLASSIDS

GetObjectID

int GetObjectID()
Returns the object id of this ACL entry.

Returns:
the object id.

GetAccessLevel

int GetAccessLevel()
Returns the access level as specified in PT_ACCESS_LEVELs.

Returns:
the access level that the group/user has on this particular object.
See Also:
PT_CLASSIDS

SetAccessLevel

void SetAccessLevel(int Value)
Sets the access level on this ACL entry.

Parameters:
accessLevel - Must be a value defined in PT_ACCESS_LEVELS.
See Also:
PT_CLASSIDS

GetReadOnly

boolean GetReadOnly()
Returns if this ACL entry is read only and therefore immutable.

Returns:
true/false if this ACL entry is changeable or not.


Copyright © 2008 Plumtree Software Inc. All Rights Reserved.