Package com.microstrategy.web.app.beans

Interface ChangePasswordBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

public interface ChangePasswordBean
extends AppComponent, RequestPersistable

This bean holds and display the required information for a user to change his/her password.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
int	getErrorMessageCode()	Get the error message code for this instance
java.lang.String	getTarget()	Get the target where it should go after the Change Password request is finished
boolean	isPasswordChanged()	Get if the password has been successfully changed
void	setErrorMessageCode(int value)	Set the error message code for this instance
void	setPasswordIsChanged(boolean isChanged)	Set if the password has been successfully changed
void	setTarget(java.lang.String target)	Set the target where it should go after the Change Password request is finished
void	setXMLStatus(int value)	Sets the EnumRequestStatus status of the bean.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

setErrorMessageCode

void setErrorMessageCode(int value)

Set the error message code for this instance

Parameters:

value - an integer value with the error code that happened while processing the change password request

getErrorMessageCode

int getErrorMessageCode()

Get the error message code for this instance

Returns:

value an integer value with the error code that happened while processing the change password request

getTarget

java.lang.String getTarget()

Get the target where it should go after the Change Password request is finished

Returns:

a String with the URL target after the Change Password is done

setTarget

void setTarget(java.lang.String target)

Set the target where it should go after the Change Password request is finished

Parameters:

target - a String with the URL target after the Change Password is done

setPasswordIsChanged

void setPasswordIsChanged(boolean isChanged)

Set if the password has been successfully changed

Parameters:

isChanged - boolean indicating if the password has been changed successfully.

isPasswordChanged

boolean isPasswordChanged()

Get if the password has been successfully changed

Returns:

boolean indicating if the password has been changed successfully.

setXMLStatus

void setXMLStatus(int value)

Sets the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.

Parameters:

value - The XML status value ofor this bean.