com.plumtree.server
Interface IPTAdminCatalog

All Superinterfaces:

IPTUnknown

public interface IPTAdminCatalog
extends IPTUnknown

All administrative objects in Plumtree are stored in a foldering system. The folders are called Admin Folders, and the Admin Catalog is the container for the Admin Folders.

Author:

michaels

See Also:

IPTAdminFolder

Method Summary

void	CopyAdminFolder(int lFolderIDToCopy, int lTargetFolderID) Copies an Admin Folder from one location to the next.
IPTAdminFolder	CreateAdminFolder(int lParentFolderID, int lFolderType) Creates a new regular admin folder in a given parent folder.
void	DeleteAdminFolder(int lFolderID) Deletes an Admin Folder and all its contents.
IPTObjectManager	GetObjectManager(int lClassID) Returns the object manager for a given class id
IPTAdminFolder	GetRootAdminFolder() Returns the root admin folder
IPTAdminFolder	GetUnclassifiedObjectsAdminFolder() Returns the unclassified objects admin folder
boolean	IsAdminFolderAccessible(int lAdminFolderID, int lMinAccessLevel) Checks if the admin folder is accessible with at least the minimum of the specified access level
void	MoveAdminFolder(int lFolderIDToBeMoved, int lTargetFolderID) Moves an admin folder to another folder.
java.lang.Object[]	MoveObjectsBetweenAdminFolders(java.lang.Object[][] vsaClassAndObjectIDs, int lFromFolderID, int lTargetFolderID) Moves objects to a different admin folder.
IPTAdminFolder	OpenAdminFolder(int lAdminFolderID, boolean bLockOnOpen) Opens a specified admin folder.
void	PropagateAdminFoldersSecurity(int lStartingAdminFolderID, int lPropMode, boolean bRecursive) Propagates security setting recursively by replacing all ACLs with the starting admin folder ACLs.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetRootAdminFolder

IPTAdminFolder GetRootAdminFolder()

Returns the root admin folder

Returns:

IPTAdminFolder of the root

See Also:

IPTAdminFolder

GetUnclassifiedObjectsAdminFolder

IPTAdminFolder GetUnclassifiedObjectsAdminFolder()

Returns the unclassified objects admin folder

Returns:

IPTAdminFolder of this folder

GetObjectManager

IPTObjectManager GetObjectManager(int lClassID)

Returns the object manager for a given class id

Parameters:

lClassID - class id of desired object manager

Returns:

IPTObjectManager

See Also:

PT_CLASSIDS

OpenAdminFolder

IPTAdminFolder OpenAdminFolder(int lAdminFolderID,
                               boolean bLockOnOpen)

Opens a specified admin folder. In order to lock, user needs at least Edit access on the folder.

Parameters:

lFolderID - folder id to open

bLockOnOpen - specifies if folder needs to be locked on opening

Returns:

IPTAdminFolder of the desired folder

CreateAdminFolder

IPTAdminFolder CreateAdminFolder(int lParentFolderID,
                                 int lFolderType)

Creates a new regular admin folder in a given parent folder. User needs create Admin Folder activity right and Edit access on the parent folder.

Parameters:

lParentFolderID - folder id of the new folder

Returns:

IPTAdminFolder of the new folder

MoveAdminFolder

void MoveAdminFolder(int lFolderIDToBeMoved,
                     int lTargetFolderID)

Moves an admin folder to another folder. User needs Admin access on source folder, Edit access on the target folder, and Edit access on the previous parent folder. An admin folder may not be moved into one of its descendants.

Parameters:

lFolderIDToBeMoved - source folder to be moved

lTargetFolderID - target folder id

CopyAdminFolder

void CopyAdminFolder(int lFolderIDToCopy,
                     int lTargetFolderID)

Copies an Admin Folder from one location to the next. User needs Admin access on the folder to copy.

Parameters:

lFolderIDToCopy - folder to copy

lTargetFolderID - target folder

DeleteAdminFolder

void DeleteAdminFolder(int lFolderID)

Deletes an Admin Folder and all its contents. User needs Admin access on a folder to delete it.

Parameters:

lFolderID - folder it to delete

MoveObjectsBetweenAdminFolders

java.lang.Object[] MoveObjectsBetweenAdminFolders(java.lang.Object[][] vsaClassAndObjectIDs,
                                                  int lFromFolderID,
                                                  int lTargetFolderID)

Moves objects to a different admin folder. User needs Edit access on the source and target folders, and Admin access on the objects being moved.

Parameters:

vsaClassAndObjectIDs - an array of class and object ids to be moved

lFromFolderID - source folder id

lTargetFolderID - target folder id

Returns:

results of each object move, indicating successful or not.

PropagateAdminFoldersSecurity

void PropagateAdminFoldersSecurity(int lStartingAdminFolderID,
                                   int lPropMode,
                                   boolean bRecursive)

Propagates security setting recursively by replacing all ACLs with the starting admin folder ACLs.

Parameters:

lStartingAdminFolderID - starting folder id

lPropMode - only takes in PT_PROPAGATE_SECURITY_REPLACE

bRecursive - doing it recursively or only one level deep

See Also:

PT_PROPAGATE_SECURITY_MODES

IsAdminFolderAccessible

boolean IsAdminFolderAccessible(int lAdminFolderID,
                                int lMinAccessLevel)

Checks if the admin folder is accessible with at least the minimum of the specified access level

Parameters:

lAdminFolderID - admin folder id to check

lMinAccessLevel - minimum access level needed

Returns:

true/false

See Also:

PT_ACCESS_LEVELS