com.plumtree.portalpages.admin.editors.user
Class UserModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.user.UserModel

All Implemented Interfaces:

IUserModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class UserModel
extends ObjEditorModel
implements IUserModelRO

Author:

SudhaS

Field Summary

protected int[]	m_aExistingGroups
protected boolean	m_bDeleteGroups
protected boolean	m_bDisabled
protected boolean	m_bExpirePassword
protected boolean	m_bExpirePasswordEnabled
protected boolean	m_bPasswordChanged
protected int	m_nUserType
protected java.lang.String	m_sSetting1
protected java.lang.String	m_sSetting2
protected java.lang.String	m_strConfirmPassword
protected java.lang.String	m_strInitialEncryptedPassword
protected java.lang.String	m_strInitialMobileUsr
protected java.lang.String	m_strInitialUserName
protected java.lang.String	m_strMobilePassword
protected java.lang.String	m_strMobileUsr
protected java.lang.String	m_strPassword
protected java.lang.String	m_strUserName
static java.lang.String	STR_MVC_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

UserModel()

Method Summary

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.
boolean	EditingGuestUser() Returns true if the User Type of the user is guest.
boolean	EditingInDefaultProfilesFolder() We need this to know if we're locking the password and locking setting in the editor
boolean	EditingLockedAccount() Return true if the user is locked.
void	ExpirePassword(int _nUserID) This helper method expires the user's password so they will have to change it the next time they log in.
java.lang.String	GetAuthUsername() Returns the user's auth user name - the name sent to a remote provider in order to authenticate the user.
java.lang.String	GetConfirmPassword() Return the confirm password variable.
boolean	GetDisabled()
boolean	GetExpirePassword() Returns true if the password is supposed to be set to expired when this editor finishes.
boolean	GetExpirePasswordEnabled() Returns true if the Expire Password feature is enabled for this editor.
java.lang.String	GetLoginName()
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetPassword()
java.lang.String	GetUniqueUsername() Returns the user's auth unique name - the unique key sent by a remote provider to identify the user.
java.lang.String	GetUserMobileName()
java.lang.String	GetUserMobilePsswrd()
protected java.lang.Object[][]	InitializeCreateMode(SelectPTObjectModel mySelectPTObjectModel)
protected java.lang.Object[][]	InitializeEditMode(SelectPTObjectModel mySelectPTObjectModel)
boolean	IsCurrentUserAdministrator()
boolean	IsPlumtreeAuthSource()
boolean	IsRemoteUser() Returns true if the user is tied to a remote authentication source.
int	SaveDevicesPage(XPHashtable _htFormData)
int	SaveMainPage(XPHashtable _htFormData)
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetConfirmPassword(java.lang.String _confirmPassword) Sets the confirm password vairable.
void	SetDeleteGroups()
protected void	SetPasswordChangedTime(long _lTime, int _nUserID) This helper method sets the Last Password Change property to the specified time.
void	StartDynamicMembershipsSelectPTObject()
void	StartSelectPTObject() Helper method to start the Select PTObject List.
boolean	UserTypeEditable() Returns whether the guest account type is editable.

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

See Also:

Constant Field Values

m_sSetting1

protected java.lang.String m_sSetting1

m_sSetting2

protected java.lang.String m_sSetting2

m_strMobilePassword

protected java.lang.String m_strMobilePassword

m_strMobileUsr

protected java.lang.String m_strMobileUsr

m_strInitialMobileUsr

protected java.lang.String m_strInitialMobileUsr

m_strPassword

protected java.lang.String m_strPassword

m_strConfirmPassword

protected java.lang.String m_strConfirmPassword

m_strUserName

protected java.lang.String m_strUserName

m_strInitialUserName

protected java.lang.String m_strInitialUserName

m_strInitialEncryptedPassword

protected java.lang.String m_strInitialEncryptedPassword

m_nUserType

protected int m_nUserType

m_aExistingGroups

protected int[] m_aExistingGroups

m_bDisabled

protected boolean m_bDisabled

m_bDeleteGroups

protected boolean m_bDeleteGroups

m_bPasswordChanged

protected boolean m_bPasswordChanged

m_bExpirePassword

protected boolean m_bExpirePassword

m_bExpirePasswordEnabled

protected boolean m_bExpirePasswordEnabled

Constructor Detail

UserModel

public UserModel()

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.

Overrides:

DoTaskAfterStore in class EditorModel

SetPasswordChangedTime

protected void SetPasswordChangedTime(long _lTime,
                                      int _nUserID)

This helper method sets the Last Password Change property to the specified time. This is necessary if password expiration is turned on.

Parameters:

_lTime - The time to set

_ptEditedUser - The user being edited.

ExpirePassword

public void ExpirePassword(int _nUserID)

This helper method expires the user's password so they will have to change it the next time they log in.

Parameters:

_ptEditedUser - The user being edited.

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 -

GetDisabled

public boolean GetDisabled()

Specified by:

GetDisabled in interface IUserModelRO

Returns:

GetLoginName

public java.lang.String GetLoginName()

Specified by:

GetLoginName in interface IUserModelRO

Returns:

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetPassword

public java.lang.String GetPassword()

Specified by:

GetPassword in interface IUserModelRO

Returns:

GetUserMobileName

public java.lang.String GetUserMobileName()

Specified by:

GetUserMobileName in interface IUserModelRO

Returns:

GetUserMobilePsswrd

public java.lang.String GetUserMobilePsswrd()

Specified by:

GetUserMobilePsswrd in interface IUserModelRO

Returns:

SaveDevicesPage

public int SaveDevicesPage(XPHashtable _htFormData)

Parameters:

_htFormData -

Returns:

SaveMainPage

public int SaveMainPage(XPHashtable _htFormData)

Parameters:

_htFormData -

Returns:

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

StartSelectPTObject

public void StartSelectPTObject()

Helper method to start the Select PTObject List.

StartDynamicMembershipsSelectPTObject

public void StartDynamicMembershipsSelectPTObject()

InitializeCreateMode

protected java.lang.Object[][] InitializeCreateMode(SelectPTObjectModel mySelectPTObjectModel)

Parameters:

mySelectPTObjectModel -

Returns:

InitializeEditMode

protected java.lang.Object[][] InitializeEditMode(SelectPTObjectModel mySelectPTObjectModel)

Parameters:

mySelectPTObjectModel -

Returns:

EditingInDefaultProfilesFolder

public boolean EditingInDefaultProfilesFolder()

We need this to know if we're locking the password and locking setting in the editor

Specified by:

EditingInDefaultProfilesFolder in interface IUserModelRO

Returns:

See Also:

IUserModelRO.EditingInDefaultProfilesFolder()

EditingGuestUser

public boolean EditingGuestUser()

Description copied from interface: IUserModelRO

Returns true if the User Type of the user is guest.

Specified by:

EditingGuestUser in interface IUserModelRO

Returns:

See Also:

IUserModelRO.EditingGuestUser()

EditingLockedAccount

public boolean EditingLockedAccount()

Return true if the user is locked.

Specified by:

EditingLockedAccount in interface IUserModelRO

Returns:

UserTypeEditable

public boolean UserTypeEditable()

Returns whether the guest account type is editable.

Specified by:

UserTypeEditable in interface IUserModelRO

Returns:

IsCurrentUserAdministrator

public boolean IsCurrentUserAdministrator()

Specified by:

IsCurrentUserAdministrator in interface IUserModelRO

IsPlumtreeAuthSource

public boolean IsPlumtreeAuthSource()

Specified by:

IsPlumtreeAuthSource in interface IUserModelRO

See Also:

IUserModelRO.IsPlumtreeAuthSource()

SetDeleteGroups

public void SetDeleteGroups()

GetAuthUsername

public java.lang.String GetAuthUsername()

Description copied from interface: IUserModelRO

Returns the user's auth user name - the name sent to a remote provider in order to authenticate the user.

Specified by:

GetAuthUsername in interface IUserModelRO

Returns:

String representing the authentication user name

GetUniqueUsername

public java.lang.String GetUniqueUsername()

Description copied from interface: IUserModelRO

Returns the user's auth unique name - the unique key sent by a remote provider to identify the user.

Specified by:

GetUniqueUsername in interface IUserModelRO

Returns:

String representing the remote unique name

IsRemoteUser

public boolean IsRemoteUser()

Description copied from interface: IUserModelRO

Returns true if the user is tied to a remote authentication source. Otherwise, false is returned.

Specified by:

IsRemoteUser in interface IUserModelRO

Returns:

boolean indicating remote status

GetConfirmPassword

public java.lang.String GetConfirmPassword()

Return the confirm password variable. START_FLAG is set return the default password string.

Specified by:

GetConfirmPassword in interface IUserModelRO

Returns:

String confirm password

SetConfirmPassword

public void SetConfirmPassword(java.lang.String _confirmPassword)

Sets the confirm password vairable.

GetExpirePassword

public boolean GetExpirePassword()

Returns true if the password is supposed to be set to expired when this editor finishes. Otherwise, false is returned.

Specified by:

GetExpirePassword in interface IUserModelRO

Returns:

boolean indicating whether or not the password should be set to expired

GetExpirePasswordEnabled

public boolean GetExpirePasswordEnabled()

Returns true if the Expire Password feature is enabled for this editor. Otherwise, false is returned.

Specified by:

GetExpirePasswordEnabled in interface IUserModelRO

Returns:

boolean indicating whether or not the Expire Password feature is enabled