com.plumtree.portaluiinfrastructure.tree
Interface IObjectTreeModelRO

All Superinterfaces:

IModelRO, IMVCObject, ITreeModelRO

All Known Subinterfaces:

IObjectTreeModel

All Known Implementing Classes:

AdminTreeModel, AObjectTreeModel, DirectoryTreeModel, TemplateTreeModel

public interface IObjectTreeModelRO
extends ITreeModelRO

Author:

Don Hayler

Method Summary

int	GetAccessLevel() This method returns the current access level.
int[]	GetDisplayedClassIDs() This method returns the class IDs to be displayed in this tree.
boolean	GetDisplayingSearchResults() This method returns whether the tree is displaying search results, or just the normal tree.
int	GetFilterClassID() This method returns the class ID to be filtered.
java.lang.String[]	GetFilterCLSID() This method returns the CLSID values used in the web service/data source query filter.
int	GetFilterCLSIDPropID() This method returns the propid for the CLSID values used in the web service/data source query filter.
int	GetFolderClassID() This method returns the class ID of the folders in the tree.
boolean	GetItemDisplayed(int nClassID, int nObjectID) This method returns whether or not the given item should be displayed.
boolean	GetItemSelected(int nClassID, int nObjectID) This method returns whether or not the given item should be selected.
int[]	GetPortletAlignment() This method returns the values used in the gadget alignment query filter.
int[]	GetPortletType() This method returns the values used in the gadget type query filter.
int[]	GetPortletWebServiceID() This method returns the values used in the gadget web service ID query filter.
boolean	GetSearchEnabled() This method returns whether or not search is enabled.
boolean	GetSearchStarted() This method returns whether or not a search has been started.
int[]	GetUserTypeFilter() This method returns the user type values used in the user query filter.

Methods inherited from interface com.plumtree.uiinfrastructure.tree.ITreeModelRO

GetActionSubTitle, GetAllChecked, GetAllowEmptySubmission, GetDisplayingFlatList, GetHelpEnabled, GetLastExpandedNodeID, GetMultipleSelect, GetOnClickFunction, GetParentFormName, GetParentFormSpaceID, GetParentFormSubmitFunction, GetRootTreeIterator, GetSelectedItems, GetSelectMode, GetSelectOptions, GetShowRoot, GetSubmitMode, GetTitle, GetTreeIsEmpty

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

GetName

Method Detail

GetAccessLevel

int GetAccessLevel()

This method returns the current access level.

Returns:

int access level

GetDisplayedClassIDs

int[] GetDisplayedClassIDs()

This method returns the class IDs to be displayed in this tree.

Returns:

int[] the class IDs to display

GetDisplayingSearchResults

boolean GetDisplayingSearchResults()

This method returns whether the tree is displaying search results, or just the normal tree.

Returns:

boolean true implies search results, false implies tree

GetFolderClassID

int GetFolderClassID()

This method returns the class ID of the folders in the tree. I.E. admin folders or card catalogs.

Returns:

int class ID of folders in the tree.

GetPortletAlignment

int[] GetPortletAlignment()

This method returns the values used in the gadget alignment query filter.

GetPortletWebServiceID

int[] GetPortletWebServiceID()

This method returns the values used in the gadget web service ID query filter.

GetPortletType

int[] GetPortletType()

This method returns the values used in the gadget type query filter.

GetUserTypeFilter

int[] GetUserTypeFilter()

This method returns the user type values used in the user query filter.

GetFilterCLSID

java.lang.String[] GetFilterCLSID()

This method returns the CLSID values used in the web service/data source query filter.

GetFilterCLSIDPropID

int GetFilterCLSIDPropID()

This method returns the propid for the CLSID values used in the web service/data source query filter.

GetFilterClassID

int GetFilterClassID()

This method returns the class ID to be filtered.

Returns:

the class ID to apply the above filter to

GetItemDisplayed

boolean GetItemDisplayed(int nClassID,
                         int nObjectID)

This method returns whether or not the given item should be displayed.

Parameters:

int - nClassID

int - nObjectID

Returns:

boolean true implies display the item

GetItemSelected

boolean GetItemSelected(int nClassID,
                        int nObjectID)

This method returns whether or not the given item should be selected.

Parameters:

int - nClassID

int - nObjectID

Returns:

boolean true implies the item is selected

GetSearchStarted

boolean GetSearchStarted()

This method returns whether or not a search has been started. This is used to tell whether or not there should be a tabbed link to the search view (no if it hasn't been started yet).

Returns:

boolean true implies should add link (search started).

GetSearchEnabled

boolean GetSearchEnabled()

This method returns whether or not search is enabled. Search will always be enabled except when displaying a pre-selected list.

Returns:

boolean true implies the search box should be displayed.