com.plumtree.portalpages.browsing.unsubscribe.communities
Class MyCommunitiesListModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          com.plumtree.portalpages.browsing.unsubscribe.communities.MyCommunitiesListModel

All Implemented Interfaces:

IMyCommunitiesListModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IExpListModelRO, IPaginationModel, IPaginationModelRO

public class MyCommunitiesListModel
extends ExpListModel
implements IMyCommunitiesListModelRO

Author:

dustina To change this generated comment edit the template variable "typecomment": Window>Preferences>Java>Templates. To enable and disable the creation of type comments go to Window>Preferences>Java>Code Generation.

Field Summary

static int	COMMLIST_COL_ID
static int	COMMLIST_COL_MAX
static int	COMMLIST_COL_MEMBERSHIPTYPE
static int	COMMLIST_COL_NAME
static int	COMMLIST_DEFAULT_INITIAL_SIZE Default initial size for the sorted array.
static java.lang.String	STR_MVC_CLASS_NAME Object Name

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

MyCommunitiesListModel()

Method Summary

void	AddRowsOnRepost(XPHashtable _htFormData) Will be called each time the add action is performed.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
boolean	displayAllMandatoryAlert() Returns the m_bDisplayAllMandatoryAlert.
java.lang.String	GetName() Returns the Class name.
void	InitCommExpList(java.lang.String _sSectionTitle, java.lang.String _sSectionSubTitle, java.lang.String _sUnsubscribeLabel) Initializes the expandable list.
void	InitializeSortedArray(PTGrowableSortedArrayWrapper _saData) Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort.
boolean	IsFreeMembership(int _nRowIndex)
protected int	SaveRow(PTGrowableSortedArrayWrapper _saData, int _nRowIndex, XPHashtable _htFormData) Will be called each ime there is a repost to save the data on the list.
void	Unsubscribe(XPHashtable _htFormData, UnsubscribeCommunitiesModel _model)
void	Unsubscribe508(int _nRowIndex, UnsubscribeCommunitiesModel _model)

Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.ExpListModel

DeleteRowsOnRepost, 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.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

Object Name

See Also:

Constant Field Values

COMMLIST_COL_MAX

public static final int COMMLIST_COL_MAX

See Also:

Constant Field Values

COMMLIST_COL_NAME

public static final int COMMLIST_COL_NAME

See Also:

Constant Field Values

COMMLIST_COL_ID

public static final int COMMLIST_COL_ID

See Also:

Constant Field Values

COMMLIST_COL_MEMBERSHIPTYPE

public static final int COMMLIST_COL_MEMBERSHIPTYPE

See Also:

Constant Field Values

COMMLIST_DEFAULT_INITIAL_SIZE

public static final int COMMLIST_DEFAULT_INITIAL_SIZE

Default initial size for the sorted array.

See Also:

Constant Field Values

Constructor Detail

MyCommunitiesListModel

public MyCommunitiesListModel()

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

Specified by:

Create in class EditorHelperModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorHelperModel

Returns:

String

InitializeSortedArray

public void InitializeSortedArray(PTGrowableSortedArrayWrapper _saData)

Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort. The growable array will always be sorted by the 1st column ascending.

Specified by:

InitializeSortedArray in class ExpListModel

Parameters:

_saData -

AddRowsOnRepost

public void AddRowsOnRepost(XPHashtable _htFormData)

Will be called each time the add action is performed. Should take care of adding the row(s) to the list. Use the GetItems() method to get the list.

Specified by:

AddRowsOnRepost in class ExpListModel

Parameters:

_htFormData - Form data

SaveRow

protected int SaveRow(PTGrowableSortedArrayWrapper _saData,
                      int _nRowIndex,
                      XPHashtable _htFormData)

Will be called each ime there is a repost to save the data on the list. Should contain the code to update the data on the row _nRowIndex.Use the SetItem method to update _saData and use _htFormData to retrieve the posted data.

Specified by:

SaveRow in class ExpListModel

Parameters:

_saData -

_nRowIndex -

_htFormData -

_nListKey -

Returns:

int

InitCommExpList

public void InitCommExpList(java.lang.String _sSectionTitle,
                            java.lang.String _sSectionSubTitle,
                            java.lang.String _sUnsubscribeLabel)

Initializes the expandable list.

Parameters:

_sSectionTitle - Main title.

_sSectionSubTitle - Sub title

_sAddLabel - Text to display next to the add icon.

_nListKey - In case you have multiple Expandable Lists on the same DP, they should have a different key (otherwise, just set it to 1).

IsFreeMembership

public boolean IsFreeMembership(int _nRowIndex)

Specified by:

IsFreeMembership in interface IMyCommunitiesListModelRO

Parameters:

_nRowIndex -

Returns:

Unsubscribe

public void Unsubscribe(XPHashtable _htFormData,
                        UnsubscribeCommunitiesModel _model)

Parameters:

_htFormData -

Unsubscribe508

public void Unsubscribe508(int _nRowIndex,
                           UnsubscribeCommunitiesModel _model)

displayAllMandatoryAlert

public boolean displayAllMandatoryAlert()

Returns the m_bDisplayAllMandatoryAlert.

Specified by:

displayAllMandatoryAlert in interface IMyCommunitiesListModelRO

Returns:

boolean