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

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          com.plumtree.uiinfrastructure.expandablelist.growablelist.GrowableListModel
              com.plumtree.portalpages.admin.editors.webservice.plugins.PrefsListPluginModel

All Implemented Interfaces:

IWSSubModel, IPrefsListPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IGrowableListModelRO, IExpListModelRO, IPaginationModel, IPaginationModelRO

public class PrefsListPluginModel
extends GrowableListModel
implements IPrefsListPluginModelRO, IWSSubModel

Author:

adolfoc

Field Summary

java.lang.String	_PrefsListMainTitle NOT Localized String: This string must be blank!
static int	PLPM_PREFMODE_COMMUNITYPREFS
static int	PLPM_PREFMODE_SESSIONPREFS
static int	PLPM_PREFMODE_USERPREFS These values specify whether this model is used to set community preferences or user preferences.
static java.lang.String	STR_MVC_CLASS_NAME

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

PrefsListPluginModel()

Method Summary

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.
int	GetPrefMode() This method checks whether this model is used to set community preferences or user preferences.
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.
int	GetWSMode() Returns our current WS display mode from the WebServiceModel.WSMODE enumeration.
void	InitWSModel(IPTWebService ptWebService) Initializes the sub-model.
void	SetPrefMode(int nPrefMode) This method specifies whether this model is used to set community preferences or user preferences.

Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.growablelist.GrowableListModel

AddRowsOnRepost, 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

PLPM_PREFMODE_USERPREFS

public static final int PLPM_PREFMODE_USERPREFS

These values specify whether this model is used to set community preferences or user preferences. The call to SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.

See Also:

Constant Field Values

PLPM_PREFMODE_COMMUNITYPREFS

public static final int PLPM_PREFMODE_COMMUNITYPREFS

See Also:

Constant Field Values

PLPM_PREFMODE_SESSIONPREFS

public static final int PLPM_PREFMODE_SESSIONPREFS

See Also:

Constant Field Values

_PrefsListMainTitle

public final java.lang.String _PrefsListMainTitle

NOT Localized String: This string must be blank!

See Also:

Constant Field Values

Constructor Detail

PrefsListPluginModel

public PrefsListPluginModel()

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()

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)

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()

GetPrefMode

public int GetPrefMode()

This method checks whether this model is used to set community preferences or user preferences. SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.

Specified by:

GetPrefMode in interface IPrefsListPluginModelRO

Returns:

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()

GetWSMode

public int GetWSMode()

Returns our current WS display mode from the WebServiceModel.WSMODE enumeration.

Specified by:

GetWSMode in interface IPrefsListPluginModelRO

Returns:

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()

SetPrefMode

public void SetPrefMode(int nPrefMode)

This method specifies whether this model is used to set community preferences or user preferences. SetPrefMode can be used to set this when the model is initialized. GetPrefMode can be used to get which mode this model is in.