com.plumtree.portaluiinfrastructure.ptmulticolumnlist
Interface IPTMultiColumnListModelRO

All Superinterfaces:
IExpListModelRO, IModelRO, IMVCObject, IPaginationModelRO
All Known Implementing Classes:
GlobalACLSyncMapListModel, PTMultiColumnListModel, UserInfoPropMapListModel

public interface IPTMultiColumnListModelRO
extends IExpListModelRO

This interface is implemented by the Model. It contains all the read-only mothods of the Model accessed by the Views.

Author:
Julie Fournier

Method Summary
 int GetAccessLevel()
          Returns the accesslevel of the objects for the tree control to display.
 java.lang.Object[][] GetCreateNewInfo()
          Returns the create new actions information.
 ASURL GetCreateNewURL(int _nClassID, java.lang.String _sEditorASName)
          Returns the URL to the Editor in create mode (new object).
 java.lang.String GetDisplayObjects()
           
 ASURL GetEditObjectURL(int _nClassID, int _nObjectID)
          Returns the URL to edit the object.
 int GetEditRow()
          Returns the row currently being edited.
 java.lang.String GetHiddenObjects()
          Returns the comma-delimited string of classids and objectids for objects that are to be hidden by the tree.
 boolean GetIncludePTSelect()
          Returns true if this list includes a Plumtree object selected from the tree object selector .
 int GetNumColumns()
          Returns the number of columns other than the columns used by the Plumtree selected object.
 java.lang.String GetObjectClassIDs()
          Returns String of Class ID of the Objects displayed in the tree.
 int GetPTObjectPosition()
          Returns the zero-based display position of the selected Plumtree object, if applicable.
 PTImageType GetRowIcon()
          Returns the icon to display on each row before the input text.
 java.lang.String GetSelectedItems()
          Returns a String of Class IDs and Object IDs of the Objects to select in the tree.
 int GetTreeLeafType()
          Returns the leaf type of the tree.
 java.lang.String GetTreeMultiSelect()
          Returns the selection type of the tree.
 java.lang.String GetTreeQueryFilter()
          Returns the query filter for the tree.
 java.lang.String GetTreeSpaceID()
          Returns tree AS ID.
 java.lang.String GetTreeSubTitle()
          Returns the Tree sub title.
 java.lang.String GetTreeTitle()
          Returns the Tree title.
 boolean IsEditLinkEnabled(int _nClassID)
          Returns true if it should be possible to edit Objects from this class ID.
 
Methods inherited from interface com.plumtree.uiinfrastructure.expandablelist.IExpListModelRO
GetAddIcon, GetAddIconAlt, GetAddLabel, GetAlertMessageForEmptyList, GetArrExpListColInfo, GetDeleteIcon, GetDeleteIconAlt, GetDelRowConfirmMsg, GetEmptyListInstructions, GetEmptyListMainMessage, GetEnableMoveRowActions, GetIsListReadOnly, GetListKey, GetMainColumnSort, GetMainColumnSortDirection, GetModelStorageName, GetReadOnlyItems, GetSectionTitle, GetTableInstructions, GetUniqueInt, GetUniqueString, GetUnusedProperties, GetWrapColumnHeaders, IsAddButtonDisabled, IsCheckBoxesDisabled, IsPaginationEnabled
 
Methods inherited from interface com.plumtree.uiinfrastructure.form.pagination.IPaginationModelRO
GetCurrentLowerObjectCount, GetCurrentUpperObjectCount, GetNumObjects, GetPaginationSize
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

GetAccessLevel

int GetAccessLevel()
Returns the accesslevel of the objects for the tree control to display.

Returns:
int

GetCreateNewInfo

java.lang.Object[][] GetCreateNewInfo()
Returns the create new actions information.

Returns:
Object[][]

GetCreateNewURL

ASURL GetCreateNewURL(int _nClassID,
                      java.lang.String _sEditorASName)
Returns the URL to the Editor in create mode (new object).

Parameters:
_nClassID -
_sEditorASName -
Returns:
ASURL URL to the Editor

GetEditObjectURL

ASURL GetEditObjectURL(int _nClassID,
                       int _nObjectID)
Returns the URL to edit the object.

Parameters:
_nClassID -
_nObjectID -
_sEditorASName -
Returns:
ASURL URL to the Editor

GetEditRow

int GetEditRow()
Returns the row currently being edited.

Returns:
int

GetHiddenObjects

java.lang.String GetHiddenObjects()
Returns the comma-delimited string of classids and objectids for objects that are to be hidden by the tree. The format of the string is as follows: ClassID1,ObjectID1, ClassID2,ObjectID2, etc..

Returns:
String

GetIncludePTSelect

boolean GetIncludePTSelect()
Returns true if this list includes a Plumtree object selected from the tree object selector .

Returns:
boolean

GetNumColumns

int GetNumColumns()
Returns the number of columns other than the columns used by the Plumtree selected object.

Returns:
int

GetObjectClassIDs

java.lang.String GetObjectClassIDs()
Returns String of Class ID of the Objects displayed in the tree. E.g.: "2,45,3" This is the format used by the tree.

Returns:
String

GetPTObjectPosition

int GetPTObjectPosition()
Returns the zero-based display position of the selected Plumtree object, if applicable.

Returns:
int

GetRowIcon

PTImageType GetRowIcon()
Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.

Returns:
PTImageType

GetSelectedItems

java.lang.String GetSelectedItems()
Returns a String of Class IDs and Object IDs of the Objects to select in the tree. E.g.: "classID1,ObjID1,classID2,objID2" This is the format used by the tree.

Returns:
String

GetTreeLeafType

int GetTreeLeafType()
Returns the leaf type of the tree.

Returns:
int

GetTreeMultiSelect

java.lang.String GetTreeMultiSelect()
Returns the selection type of the tree. Converts the boolean value to a string so that it can be put in the query string for the tree.

Returns:
String

GetTreeQueryFilter

java.lang.String GetTreeQueryFilter()
Returns the query filter for the tree.

Returns:
String

GetTreeSpaceID

java.lang.String GetTreeSpaceID()
Returns tree AS ID.

Returns:
String

GetTreeSubTitle

java.lang.String GetTreeSubTitle()
Returns the Tree sub title.

Returns:
String

GetTreeTitle

java.lang.String GetTreeTitle()
Returns the Tree title.

Returns:
String

GetDisplayObjects

java.lang.String GetDisplayObjects()
See Also:
SelectPTObjectModel.GetDisplayObjects()

IsEditLinkEnabled

boolean IsEditLinkEnabled(int _nClassID)
Returns true if it should be possible to edit Objects from this class ID.

Parameters:
_nClassID -



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.