com.plumtree.server
Interface IPTSiteMapFolderManager

public interface IPTSiteMapFolderManager

IPTSiteMapFolderManager

Author:

Self-Service Communities

Method Summary

IPTSiteMapFolderInfo	CachedOpenSiteMapFolderInfo(int nSiteMapFolderID) Get an IPTSiteMapFolderInfo object for a particular Site Map folder.
void	MoveFolder(int nFolderToMove, int nDestinationFolder) Move a folder from one location to another.
java.lang.Object[]	RecursiveDelete(int nSiteMapFolderID) Delete the entire tree of all the folders and links that are below a particular folder in the hierarchy, including the current folder.

Method Detail

RecursiveDelete

java.lang.Object[] RecursiveDelete(int nSiteMapFolderID)

Delete the entire tree of all the folders and links that are below a particular folder in the hierarchy, including the current folder.

Parameters:

nSiteMapFolderID - - folder ID to delete

Returns:

Object[] - results of the deletions

CachedOpenSiteMapFolderInfo

IPTSiteMapFolderInfo CachedOpenSiteMapFolderInfo(int nSiteMapFolderID)

Get an IPTSiteMapFolderInfo object for a particular Site Map folder.

Parameters:

nSiteMapFolderID - - folder id to open

Returns:

IPTSiteMapFolderInfo - cached site map folder information

MoveFolder

void MoveFolder(int nFolderToMove,
                int nDestinationFolder)

Move a folder from one location to another. This function fails if the destination folder is a child of the folder to move.

Parameters:

nFolderToMove - - folder id of the folder to move

nDestinationFolder - - folder id of the destination folder