com.plumtree.portalpages.admin.editors.group
Class GroupModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.group.GroupModel

All Implemented Interfaces:

IGroupModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IFilterIteratorContainerRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class GroupModel
extends ObjEditorModel
implements IGroupModelRO

This class handles all the data for the Group Editor. Methods are called by the control when the user switches between display pages, and also when the user finishes.

Author:

RickyW

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME class name

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

GroupModel()

Method Summary

protected void	CheckForTooManyUsersToDisplay()
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed before the object is stored.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code executed when the Editor is starting.
IFilterIteratorRO	GetFilterIterator() Returns the current filter iterator.
java.lang.String	GetName() Returns the Class name.
java.lang.Object[]	GetUserNonReferenceProperties(IPTSession ptSession)
boolean	IsRemoteGroup()
void	LoadGroupInfo() If we are editing an exisiting group, we need to load the group's data.
java.lang.Object[][]	LoadMembers()
java.lang.Object[][]	LoadMembers(int nMaxRows, int nRowsToSkip)
void	ModifyMemberOfRow(XPHashtable _htFormData) Action for modifying a member of row on the Dynamic Membership Rules page.
void	PreviewMembershipFilter()
protected int	SaveActivityRightsPage(XPHashtable _htFormData) Saves data on Activity Rights page.
protected int	SaveDynamicRulesPage(XPHashtable _htFormData) Saves data on Dynamic Membership Rules page.
protected int	SaveMainSettingsPage(XPHashtable _htFormData) Saves data on Main Settings page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetHiddenMemberGroups() Set which groups we don't want to be able to add.
void	SetHiddenParentGroups() Set which groups we don't want to be able to add.
protected void	SetUpdateDynamicMembersOnFinish(boolean b)
protected boolean	ShouldUpdateDynamicMembersOnFinish()
void	StartDynamicMemberListRO() Helper method to start the dynamic members list.
void	StartDynamicRulesChooser() Helper method to start the dynamic members list.
void	StartInheritedRightsList() Helper method to start the inherited rights select list.
void	StartSelectDynMemberPreviewPopup() Helper method to start the dynamic members list.
void	StartSelectedRightsList() Helper method to start the Select List.
void	StartSelectMemberGroups() Helper method to start the SelectPTObject List.
void	StartSelectParentGroups() Helper method to start the Select Parents Groups Expandable List.
void	UpdateGroupMembershipRow(int nGroupIndex, int nStatementIndex, java.lang.Object oGroupID, java.lang.String sGroupName) Updates the Filter and FilterIterator associated with this model.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

Cancel, CleanupAllData, CleanupTempData, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.portaluiinfrastructure.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

class name

See Also:

Constant Field Values

Constructor Detail

GroupModel

public GroupModel()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: EditorModel

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 EditorModel

Returns:

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

See Also:

IManagedObject.Create()

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored. Groups must exist before information can be added to them. Therefore, all of the group's data is saved here.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code executed when the Editor is starting.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetName

public java.lang.String GetName()

Description copied from class: EditorModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

IsRemoteGroup

public boolean IsRemoteGroup()

Specified by:

IsRemoteGroup in interface IGroupModelRO

ShouldUpdateDynamicMembersOnFinish

protected boolean ShouldUpdateDynamicMembersOnFinish()

SetUpdateDynamicMembersOnFinish

protected void SetUpdateDynamicMembersOnFinish(boolean b)

GetFilterIterator

public IFilterIteratorRO GetFilterIterator()

Returns the current filter iterator.

Specified by:

GetFilterIterator in interface IFilterIteratorContainerRO

Returns:

the current filter iterator.

LoadMembers

public java.lang.Object[][] LoadMembers()

LoadMembers

public java.lang.Object[][] LoadMembers(int nMaxRows,
                                        int nRowsToSkip)

CheckForTooManyUsersToDisplay

protected void CheckForTooManyUsersToDisplay()

LoadGroupInfo

public void LoadGroupInfo()

If we are editing an exisiting group, we need to load the group's data.

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

StartSelectedRightsList

public void StartSelectedRightsList()

Helper method to start the Select List.

StartInheritedRightsList

public void StartInheritedRightsList()

Helper method to start the inherited rights select list.

StartSelectMemberGroups

public void StartSelectMemberGroups()

Helper method to start the SelectPTObject List.

StartDynamicMemberListRO

public void StartDynamicMemberListRO()

Helper method to start the dynamic members list.

StartSelectParentGroups

public void StartSelectParentGroups()

Helper method to start the Select Parents Groups Expandable List.

StartDynamicRulesChooser

public void StartDynamicRulesChooser()

Helper method to start the dynamic members list.

GetUserNonReferenceProperties

public java.lang.Object[] GetUserNonReferenceProperties(IPTSession ptSession)

StartSelectDynMemberPreviewPopup

public void StartSelectDynMemberPreviewPopup()

Helper method to start the dynamic members list.

SetHiddenMemberGroups

public void SetHiddenMemberGroups()

Set which groups we don't want to be able to add.

Specified by:

SetHiddenMemberGroups in interface IGroupModelRO

SetHiddenParentGroups

public void SetHiddenParentGroups()

Set which groups we don't want to be able to add.

Specified by:

SetHiddenParentGroups in interface IGroupModelRO

SaveActivityRightsPage

protected int SaveActivityRightsPage(XPHashtable _htFormData)

Saves data on Activity Rights page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

SaveMainSettingsPage

protected int SaveMainSettingsPage(XPHashtable _htFormData)

Saves data on Main Settings page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

SaveDynamicRulesPage

protected int SaveDynamicRulesPage(XPHashtable _htFormData)

Saves data on Dynamic Membership Rules page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

PreviewMembershipFilter

public void PreviewMembershipFilter()

ModifyMemberOfRow

public void ModifyMemberOfRow(XPHashtable _htFormData)

Action for modifying a member of row on the Dynamic Membership Rules page.

Parameters:

_htFormData - Form data

UpdateGroupMembershipRow

public void UpdateGroupMembershipRow(int nGroupIndex,
                                     int nStatementIndex,
                                     java.lang.Object oGroupID,
                                     java.lang.String sGroupName)

Updates the Filter and FilterIterator associated with this model. Specifically updates the statement in the group specified to have a group membership id and string associated with it.

Parameters:

nGroupIndex -

nStatementIndex -

oGroupID -

sGroupName -