com.plumtree.portalpages.admin.editors.webservice.plugins
Class AddUserInfoPluginModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorHelperModel
      extended by com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          extended by com.plumtree.uiinfrastructure.expandablelist.growablelist.GrowableListModel
              extended by com.plumtree.portalpages.admin.editors.webservice.plugins.AddUserInfoPluginModel
All Implemented Interfaces:
IWSSubModel, IAddUserInfoPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IGrowableListModelRO, IExpListModelRO, IPaginationModel, IPaginationModelRO

public class AddUserInfoPluginModel
extends GrowableListModel
implements IAddUserInfoPluginModelRO, IWSSubModel

Author:
adolfoc

Field Summary
static int EXPLIST_COL_CLASSID
          This column contains the Object Class IDs.
static int EXPLIST_COL_OBJECTID
          This column contains the Object IDs.
static int EXPLIST_COL_STRING
          This is the String that we doisplay in the list.
protected  java.lang.String m_sTreeSpaceID
          Tree Space ID.
static java.lang.String STR_MVC_CLASS_NAME
           
static java.lang.String SUBSPACE_NAME_SELECTTREE
          Key name used by the Activity Space to store the tree.
 
Fields inherited from class com.plumtree.uiinfrastructure.expandablelist.growablelist.GrowableListModel
CLIENT_VALIDATION_TYPE_NON_EMPTY_STRING, CLIENT_VALIDATION_TYPE_NONE, CLIENT_VALIDATION_TYPE_STRING_NO_SPACE, CLIENT_VALIDATION_TYPE_VALID_URL, EXPLIST_COL_MAX, EXPLIST_SORTEDARRAY_PROPID_INPUTTEXT, m_imgRowIcon, m_nClientValidationType, m_sAlertMessage, m_sDefaultValue
 
Fields inherited from class com.plumtree.uiinfrastructure.expandablelist.ExpListModel
EXPLIST_COLUMN_COLSPAN, EXPLIST_COLUMN_ENABLESORT, EXPLIST_COLUMN_ID, EXPLIST_COLUMN_INVALID, EXPLIST_COLUMN_TITLE, EXPLIST_COLUMN_WIDTH, EXPLIST_SORTEDARRAY_PROPID_INDEX, m_arrExpListColInfo, m_bAddButtonDisabled, m_bCheckBoxesDisabled, m_bEnableMoveRowActions, m_bIsReadOnly, m_bWrapColumnHeaders, m_imgAddIcon, m_imgDeleteIcon, m_nListKey, m_nNextIndex, m_saData, m_sAddIconAlt, m_sAddLabel, m_sDeleteIconAlt, m_sDelRowConfirmMsg, m_sEmptyListAlert, m_sInstructions, m_sMainMessage, m_sSectionTitle, m_sTableInstructions, MAX_ROWS, MOVEACTION_DOWN, MOVEACTION_FIRST, MOVEACTION_LAST, MOVEACTION_UP, parent
 
Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel
m_asOwner
 
Constructor Summary
AddUserInfoPluginModel()
           
 
Method Summary
 void AddRowsOnRepost(XPHashtable _htFormData)
          Clear the list and add all the values from the tree.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 void DeleteRowsOnRepost(XPHashtable _htFormData)
          Gets the array of checked rows and delete them from the list.
 void DoTaskBeforeWSStore()
          Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.
 void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID, java.lang.String strRemoteServerName, java.lang.String strRemoteServerBaseURL)
          Called when the Remote Server is changed.
 void DoTaskOnWSModeUpdate(int nNewWSMode)
          Called when the Web Service type is changed.
 java.lang.String GetName()
          Returns the Class name.
 XPArrayList GetSelectedItemsFromTree()
          Returns the list of Userinfo's retrieved from the Tree.
 java.lang.String GetTreeSpaceID()
          Returns tree AS ID.
 java.lang.String GetValidationFunction()
          This returns the name of the client-side validation function that the model wants added to the page-level validation funtion.
 boolean InCurrentList(java.lang.String strItem)
          Searches the current list of GetListValues for strItem.
 void InitWSModel(IPTWebService ptWebService)
          Initializes the sub-model.
protected  void SaveTreeID(XPHashtable _htFormData)
          Helper method to save the Tree ID on repost.
 
Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.growablelist.GrowableListModel
AddRowsToList, GetAlertMessage, GetClientValidationType, GetListValues, GetRowIcon, InitializeGrowableList, InitializeSortedArray, SaveRow, SetClientValidationType, SetDefaultValue, SetRowIcon
 
Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.ExpListModel
DisableAddButton, DisableCheckBoxes, EnablePagination, GetAddIcon, GetAddIconAlt, GetAddLabel, GetAlertMessageForEmptyList, GetArrayOfObjToDelete, GetArrExpListColInfo, GetCurrentLowerObjectCount, GetCurrentUpperObjectCount, GetDeleteIcon, GetDeleteIconAlt, GetDelRowConfirmMsg, GetEmptyListInstructions, GetEmptyListMainMessage, GetEnableMoveRowActions, GetIsListReadOnly, GetItems, GetListKey, GetMainColumnSort, GetMainColumnSortDirection, GetModelStorageName, GetMoveAction, GetNumObjects, GetPaginationSize, GetReadOnlyItems, GetRowIndex, GetSectionTitle, GetTableInstructions, GetUniqueInt, GetUniqueString, GetUnusedProperties, GetWrapColumnHeaders, InitializeExpandableList, InitializeReadOnlyExpandableList, IsAddButtonDisabled, IsCheckBoxesDisabled, IsPaginationEnabled, ModifyRow, MoveDown, MoveFirst, MoveLast, MoveRow, MoveUp, ReverseCurrentSort, SaveSection, SetAddIcon, SetAddIconAlt, SetDeleteIcon, SetDeleteIconAlt, SetDelRowConfirmMsg, SetEmptyListMessages, SetEnableEmptyListClientValidation, SetEnableMoveRowActions, SetIsListReadOnly, SetListKey, SetPagination, SetSectionTitle, SetTableInstructions, SetWrapColumnHeaders, SortByColumn
 
Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel
CleanupAllData, CleanupTempData, Init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.plumtree.uiinfrastructure.expandablelist.growablelist.IGrowableListModelRO
GetAlertMessage, GetClientValidationType, GetRowIcon
 
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.IModel
CleanupAllData, CleanupTempData, Init
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
See Also:
Constant Field Values

SUBSPACE_NAME_SELECTTREE

public static final java.lang.String SUBSPACE_NAME_SELECTTREE
Key name used by the Activity Space to store the tree.

See Also:
Constant Field Values

EXPLIST_COL_CLASSID

public static final int EXPLIST_COL_CLASSID
This column contains the Object Class IDs.

See Also:
Constant Field Values

EXPLIST_COL_OBJECTID

public static final int EXPLIST_COL_OBJECTID
This column contains the Object IDs.

See Also:
Constant Field Values

EXPLIST_COL_STRING

public static final int EXPLIST_COL_STRING
This is the String that we doisplay in the list. E.g.: Object name or folder path.

See Also:
Constant Field Values

m_sTreeSpaceID

protected java.lang.String m_sTreeSpaceID
Tree Space ID. The first time the ID is empty and a new AS is opened, but after that, we save the ID and the same tree AS is reopened each time.

Constructor Detail

AddUserInfoPluginModel

public AddUserInfoPluginModel()
Method Detail

Create

public java.lang.Object Create()
Description copied from class: EditorHelperModel
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Overrides:
Create in class GrowableListModel
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

DoTaskBeforeWSStore

public void DoTaskBeforeWSStore()
Description copied from interface: IWSSubModel
Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.

Specified by:
DoTaskBeforeWSStore in interface IWSSubModel
See Also:
IWSSubModel.DoTaskBeforeWSStore()

DoTaskOnRemoteServerUpdate

public void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID,
                                       java.lang.String strRemoteServerName,
                                       java.lang.String strRemoteServerBaseURL)
Description copied from interface: IWSSubModel
Called when the Remote Server is changed. This is mostly used to update the base-url displayed before URL edit boxes.

Specified by:
DoTaskOnRemoteServerUpdate in interface IWSSubModel
See Also:
IWSSubModel.DoTaskOnRemoteServerUpdate(String, String, String)

DoTaskOnWSModeUpdate

public void DoTaskOnWSModeUpdate(int nNewWSMode)
Description copied from interface: IWSSubModel
Called when the Web Service type is changed.

Specified by:
DoTaskOnWSModeUpdate in interface IWSSubModel
See Also:
IWSSubModel.DoTaskOnWSModeUpdate(int)

GetName

public java.lang.String GetName()
Description copied from class: GrowableListModel
Returns the Class name.

Specified by:
GetName in interface IMVCObject
Overrides:
GetName in class GrowableListModel
Returns:
String
See Also:
IMVCObject.GetName()

GetSelectedItemsFromTree

public XPArrayList GetSelectedItemsFromTree()
Returns the list of Userinfo's retrieved from the Tree. (Returns an empty array if the tree has not been initialized).

Returns:
XPArrayList

GetTreeSpaceID

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

Specified by:
GetTreeSpaceID in interface IAddUserInfoPluginModelRO
Returns:
String

GetValidationFunction

public java.lang.String GetValidationFunction()
Description copied from interface: IWSSubModel
This returns the name of the client-side validation function that the model wants added to the page-level validation funtion. Models return null or "" if they don't have a validation function.

Specified by:
GetValidationFunction in interface IWSSubModel
See Also:
IWSSubModel.GetValidationFunction()

InCurrentList

public boolean InCurrentList(java.lang.String strItem)
Searches the current list of GetListValues for strItem. Returns true if strItem is found. (Does a case sensitive comparison).

Parameters:
strItem -
Returns:
boolean

InitWSModel

public void InitWSModel(IPTWebService ptWebService)
Description copied from interface: IWSSubModel
Initializes the sub-model. Provides an opportunity for the submodel to load it's state from the WebService.

Specified by:
InitWSModel in interface IWSSubModel
See Also:
com.plumtree.portalpages.admin.editors.webservice.IWSSubModel#InitWSModel()

AddRowsOnRepost

public void AddRowsOnRepost(XPHashtable _htFormData)
Clear the list and add all the values from the tree.

Overrides:
AddRowsOnRepost in class GrowableListModel
Parameters:
_htFormData - Form data

DeleteRowsOnRepost

public void DeleteRowsOnRepost(XPHashtable _htFormData)
Description copied from class: ExpListModel
Gets the array of checked rows and delete them from the list.

Overrides:
DeleteRowsOnRepost in class ExpListModel
See Also:
ExpListModel.DeleteRowsOnRepost(XPHashtable)

SaveTreeID

protected void SaveTreeID(XPHashtable _htFormData)
Helper method to save the Tree ID on repost.

Parameters:
_htFormData - Form data



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