com.businessobjects.jsf.sdk.components
Class UIChangePassword

java.lang.Object
  |
  +--UICommand
        |
        +--com.businessobjects.jsf.sdk.components.UIBaseControl
              |
              +--com.businessobjects.jsf.sdk.components.UIChangePassword

public class UIChangePassword

extends UIBaseControl

Allows the user to change their BusinessObjects Enterprise logon password.

See Also:

Serialized Form

Field Summary

static java.lang.String

TYPE

Constructor Summary

UIChangePassword()

Method Summary

void	decode(FacesContext context) For internal use only.
java.lang.String	getConfirmText() Gets the text to display for the new password confirmation label.
java.lang.String	getFamily() For internal use only.
IIdentity	getIdentity() Gets the Identity bean that is data bound to the ChangePassword component.
int	getLabelAlignment() Gets the horizontal alignment of all labels.
java.lang.String	getNewPasswordText() Gets the text to display for the new password label.
java.lang.String	getOldPasswordText() Gets the text to display for the old password label.
SubmitButtonProps	getSubmitButton() Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setAutoHandleEvents(boolean autoHandleEvents) Sets a value indicating whether the ChangePassword component assumes responsibility for handling its own events.
void	setConfirmText(java.lang.String confirmText) Sets the text to display for the new password confirmation label.
void	setIdentity(IIdentity identity) Sets the Identity bean that is data bound to the ChangePassword component.
void	setLabelAlignment(int labelAlignment) Sets the horizontal alignment of all labels.
void	setLocale(java.util.Locale locale) Sets the locale setting used to display all text and formatting generated by the ChangePassword component.
void	setNewPasswordText(java.lang.String newPasswordText) Sets the text to display for the new password label.
void	setOldPasswordText(java.lang.String oldPasswordText) Sets the text to display for the old password label.
void	setSubmitButton(SubmitButtonProps submitButton) Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.
void	submit(IIdentity identity) Applies the password changes for the user to the system.

Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl

getItemSource, getLocale, getTitle, isAutoHandleEvents, isEnabled, setEnabled, setItemSource, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static java.lang.String TYPE

Constructor Detail

UIChangePassword

public UIChangePassword()

Method Detail

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale setting used to display all text and formatting generated by the ChangePassword component.

Overrides:

setLocale in class UIBaseControl

Parameters:

locale - The component's locale.

setAutoHandleEvents

public void setAutoHandleEvents(boolean autoHandleEvents)

Sets a value indicating whether the ChangePassword component assumes responsibility for handling its own events.

Overrides:

setAutoHandleEvents in class UIBaseControl

Parameters:

autoHandleEvents - true if the control will react to its own events using a built-in event handler, otherwise, false.

getIdentity

public IIdentity getIdentity()

Gets the Identity bean that is data bound to the ChangePassword component.

Returns:

the Identity bean

setIdentity

public void setIdentity(IIdentity identity)

Sets the Identity bean that is data bound to the ChangePassword component.

Parameters:

identity - the Identity bean to bind to the ChangePassword component

getLabelAlignment

public int getLabelAlignment()

Gets the horizontal alignment of all labels.

Returns:

the horizontal alignment of all labels as an int

setLabelAlignment

public void setLabelAlignment(int labelAlignment)

Sets the horizontal alignment of all labels.

Parameters:

labelAlignment - the horizontal alignment of all labels as an int

getOldPasswordText

public java.lang.String getOldPasswordText()

Gets the text to display for the old password label.

Returns:

the text to display for the old password label

setOldPasswordText

public void setOldPasswordText(java.lang.String oldPasswordText)

Sets the text to display for the old password label.

Parameters:

oldPasswordText - the text to display for the old password label

getNewPasswordText

public java.lang.String getNewPasswordText()

Gets the text to display for the new password label.

Returns:

the text to display for the new password label

setNewPasswordText

public void setNewPasswordText(java.lang.String newPasswordText)

Sets the text to display for the new password label.

Parameters:

newPasswordText - the text to display for the new password label

getConfirmText

public java.lang.String getConfirmText()

Gets the text to display for the new password confirmation label.

Returns:

the text to display for the new password confirmation label

setConfirmText

public void setConfirmText(java.lang.String confirmText)

Sets the text to display for the new password confirmation label.

Parameters:

confirmText - the text to display for the new password confirmation label

getSubmitButton

public SubmitButtonProps getSubmitButton()

Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

Returns:

an instance of the SubmitButtonProps class which specifies the properties of the submit button

setSubmitButton

public void setSubmitButton(SubmitButtonProps submitButton)

Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

Returns:

submitButton an instance of the SubmitButtonProps class which specifies the properties of the submit button

decode

public void decode(FacesContext context)

For internal use only.

submit

public void submit(IIdentity identity)

Applies the password changes for the user to the system.

Parameters:

identity - an IIdentity object that contains the user information

saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.

Overrides:

saveState in class UIBaseControl

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

For internal use only.

Overrides:

restoreState in class UIBaseControl

getFamily

public java.lang.String getFamily()

For internal use only.