com.plumtree.server
Interface IPTAccessList

All Superinterfaces:

IPTUnknown

public interface IPTAccessList
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:

IPTAccessListEntry

Method Summary

IPTAccessListEntry	Add(int nClassID, int nObjectID, int AccessLevel, java.lang.String bstrName, int nIndex, boolean bReadonly) Adds a new entry to the access list
void	AggressiveMerge(IPTAccessList pACL) Similar to Merge, but without accounting for read-only items (i.e.
void	Clear() Removes the non-read only entries from the access list
void	ClearCompletely() Removes all entries in the list without regards to read-only attributes
IPTAccessList	Clone() Clones the access list
IPTAccessListEntry	Find(int nClassID, int nObjectID) Finds an entry in the list that matches the given classID and objectID
IPTAccessList	GetAdminACLs() Returns the Admin only entries in the current ACL
int	GetCount() Gets the number of access list entries
com.plumtree.openfoundation.util.IXPEnumerator	GetEnumerator() Returns the enumerator over the access list
IPTAccessListEntry	GetItem(int nIndex) Retrieves an access list entry
boolean	IsAdminModified(IPTAccessList spOldACL) Checks if there are new Admin entries or existing ones modified to Admin.
boolean	IsDifferent(IPTAccessList spACL) Checks if the passed-in IPTAccessList is different from this one
void	Merge(IPTAccessList pACL) Merges access list with the spFromACL argument.
void	Remove(int nIndex) Removes a particular access list entry as specified by index

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetItem

IPTAccessListEntry GetItem(int nIndex)

Retrieves an access list entry

Parameters:

index - index of entry to retrieve

Returns:

IPTAccessListEntry of the desired entry

GetEnumerator

com.plumtree.openfoundation.util.IXPEnumerator GetEnumerator()

Returns the enumerator over the access list

Returns:

IXPEnumerator

GetCount

int GetCount()

Gets the number of access list entries

Returns:

size of the access list

Remove

void Remove(int nIndex)

Removes a particular access list entry as specified by index

Parameters:

index - index of entry to remove

Add

IPTAccessListEntry Add(int nClassID,
                       int nObjectID,
                       int AccessLevel,
                       java.lang.String bstrName,
                       int nIndex,
                       boolean bReadonly)

Adds a new entry to the access list

Parameters:

classID - class id - PT_CLASSIDS

objectID - object id of object

accessLevel - Access Level PT_ACCESS_LEVELS

name - name

index - defaultvalue(-1)

readOnly - defaultvalue(FALSE)

Returns:

IPTAccessListEntry added

See Also:

IPTAccessListEntry, PT_CLASSIDS, PT_ACCESS_LEVELS

Clear

void Clear()

Removes the non-read only entries from the access list

Clone

IPTAccessList Clone()

Clones the access list

Returns:

cloned IPTAccessList

Find

IPTAccessListEntry Find(int nClassID,
                        int nObjectID)

Finds an entry in the list that matches the given classID and objectID

Parameters:

classID - must be either PT_USER_ID or PT_USERGROUPID

objectID - object id

Returns:

IPTAccessListEntry if found, null if not

Merge

void Merge(IPTAccessList pACL)

Merges access list with the spFromACL argument. If an entry already exists, the higher access level value will be used. Read-only items will not be modified.

Parameters:

pACL - IPTAccessList to merge with

AggressiveMerge

void AggressiveMerge(IPTAccessList pACL)

Similar to Merge, but without accounting for read-only items (i.e. they will be modified). If an entry already exists, the higher access level value will be used.

Parameters:

pACL - IPTAccessList to merge with

ClearCompletely

void ClearCompletely()

Removes all entries in the list without regards to read-only attributes

IsDifferent

boolean IsDifferent(IPTAccessList spACL)

Checks if the passed-in IPTAccessList is different from this one

Parameters:

list - IPTAccessList to check against

Returns:

true/false

IsAdminModified

boolean IsAdminModified(IPTAccessList spOldACL)

Checks if there are new Admin entries or existing ones modified to Admin.

Parameters:

list - IPTAccessList old ACL to check against

Returns:

true/false

GetAdminACLs

IPTAccessList GetAdminACLs()

Returns the Admin only entries in the current ACL

Returns:

IPTAccessList