com.plumtree.portalpages.common.folder
Interface IFolderModelRO

All Superinterfaces:

IModelRO, IMVCObject

All Known Subinterfaces:

IDirModel, IDirModelRO, ISiteMapModelRO

All Known Implementing Classes:

DirModel, ObjectSelectionModel, ObjMgrModel, PortletInBundleObjectSelectionModel, SiteMapModel

public interface IFolderModelRO
extends IModelRO

Author:

Don Hayler, RupaP

Method Summary

int	GetCurrentFolderID() Get the id of the current folder.
int	GetCurrentFolderLevel() Get the level of the current folder
java.lang.String	GetCurrentFolderName() Get the name of the current folder.
int	GetFirstFolderIndex() Get the index of the first folder to display.
int	GetFolderColumnCount() Get the number of columns to display.
IASQueryResult	GetFolderObjectCount() Get a list of object names and the number of those objects in the current folder.
IASQueryResult	GetFolderQueryResult() Get an IPTQueryResult containing all of the subfolders of the current folder.
IFolderViewHelper	GetFolderViewHelper() Retrieves the folder view helper.
boolean	GetIsFolderSelected(int nFolderID) This method returns whether or not the requested folder is currently selected.
int	GetLastFolderIndex() Get the index of the first folder to display.
int	GetNumSubSubFoldersToDisplay() Set the number of sub-subfolders to display after the next page..
int	GetParentFolderID() Get the ID of the parent folder of the current folder.
java.lang.Object[]	GetParentFolderIDs() Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder.
java.lang.String	GetPath() Get the path to the current folder concatenated with '\'.
boolean	GetShowCheckbox() Returns whether the folders should have checkboxes next to them.
boolean	GetShowFolderBanner() Returns whether the subfolder banner should be shown.
int	GetSubFolderCount() Get the number of folders at all levels in the hierachy
int	GetSubFolderCount(int nFolderLevel) Get the number of sub folders in the current folder at the specified level.
boolean	InRootFolder() Returns true if the current folder is the root folder.

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Method Detail

GetCurrentFolderID

int GetCurrentFolderID()

Get the id of the current folder.

GetCurrentFolderLevel

int GetCurrentFolderLevel()

Get the level of the current folder

GetCurrentFolderName

java.lang.String GetCurrentFolderName()

Get the name of the current folder.

GetFirstFolderIndex

int GetFirstFolderIndex()

Get the index of the first folder to display.

GetFolderColumnCount

int GetFolderColumnCount()

Get the number of columns to display.

GetFolderObjectCount

IASQueryResult GetFolderObjectCount()

Get a list of object names and the number of those objects in the current folder. The list will have PT_PROPID_CLASSID ("filter 32") and PT_PROPID_OBJECTCOUNT (12).

GetFolderQueryResult

IASQueryResult GetFolderQueryResult()

Get an IPTQueryResult containing all of the subfolders of the current folder.

GetFolderViewHelper

IFolderViewHelper GetFolderViewHelper()

Retrieves the folder view helper. This contains a method to implement display for one folder. FolderViewHelper is the implementation for general use, but you may need to implement your own helper.

GetIsFolderSelected

boolean GetIsFolderSelected(int nFolderID)

This method returns whether or not the requested folder is currently selected.

Returns:

boolean true implies selected, false implies not selected

GetLastFolderIndex

int GetLastFolderIndex()

Get the index of the first folder to display.

GetNumSubSubFoldersToDisplay

int GetNumSubSubFoldersToDisplay()

Set the number of sub-subfolders to display after the next page..

GetParentFolderID

int GetParentFolderID()

Get the ID of the parent folder of the current folder.

GetParentFolderIDs

java.lang.Object[] GetParentFolderIDs()

Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder. Each element in the array must be cast to an Integer. This will return one ID per folder in the path, except for the root folder, where two IDs will be returned even though there is only one folder in the path.

GetPath

java.lang.String GetPath()

Get the path to the current folder concatenated with '\'.

GetShowCheckbox

boolean GetShowCheckbox()

Returns whether the folders should have checkboxes next to them.

GetShowFolderBanner

boolean GetShowFolderBanner()

Returns whether the subfolder banner should be shown.

GetSubFolderCount

int GetSubFolderCount(int nFolderLevel)

Get the number of sub folders in the current folder at the specified level.

GetSubFolderCount

int GetSubFolderCount()

Get the number of folders at all levels in the hierachy

InRootFolder

boolean InRootFolder()

Returns true if the current folder is the root folder.