public class

ChangePasswordGeneralTransform

extends AbstractChangePasswordTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractChangePasswordTransform
           ↳ com.microstrategy.web.app.transforms.ChangePasswordGeneralTransform
Known Direct Subclasses

Class Overview

This transform renders the change password dialog to the user, including the form input fields so the setting can be updated if submitting the request.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ChangePasswordGeneralTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
void renderChangePasswordError(MarkupOutput out)
Render the HTML corresponding to this transform for the ChangePasswordBean bean, when its state indicates there was a problem with the information available or provided by the user.
void renderChangePasswordGeneral(MarkupOutput out)
Render the HTML corresponding to this transform for the ChangePasswordBean bean, when its state indicates there is input expected from the user.
void renderChangePasswordSuccessful(MarkupOutput out)
Render the HTML corresponding to this transform for the ChangePasswordBean bean.
void renderExitChangePasswordPage(MarkupOutput out)
Render a message indicating the user where s/he is now connected to, if the information is available.
void renderMissingFieldsError(MarkupOutput out, String errorField)
If error was found given missing information, this method displays the corresponding message.
void renderSuccessfulMessage(MarkupOutput out)
Render a message to indicate the user's password has been changed.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by assigning a default URL information to the anchor (based on the getDoneURLLink method) when event is not defined.
String getArgumentName(WebEvent event, int argumentId)
Get the name of the argument assigned to the WebEvent, based on the indicated id.
WebEvent getCancelEvent()
Returns a WebEvent instance of the event submitted when the user clicks on the Cancel button.
WebEvent getChangePasswordEvent(ChangePasswordBean bean)
Based on the information available on the bean, generate the event that will be used for allowing the user to change the password
WebEvent getDefaultEvent(ChangePasswordBean bean)
Get the WebEvent that will be shown to the user once the password has been changed.
String getDoneURLLink(ChangePasswordBean bean)
Determines the URL to use for indicating where to take the user once the password has been changed.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractChangePasswordTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public ChangePasswordGeneralTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public void renderChangePasswordError (MarkupOutput out)

Render the HTML corresponding to this transform for the ChangePasswordBean bean, when its state indicates there was a problem with the information available or provided by the user. By default, called by the transformForRequestInError() method. Since when the bean is in error state, the user can still enter information for having it processed again, this method by default calls renderChangePasswordGeneral().

Parameters
out MarkupOutput instance where to save the HTML to be shown to the user

public void renderChangePasswordGeneral (MarkupOutput out)

Render the HTML corresponding to this transform for the ChangePasswordBean bean, when its state indicates there is input expected from the user. By default, called by the transformForRequestWaitingForUserInput() method. Generates the dialog interface for the user to be able to change his or her password. It also displays information about where this change will be applied: which server, for which user, etc. If not enough information is available for proceeding with a future change password request, an error message will be displayed indicating which fields are missing.

Parameters
out MarkupOutput instance where to save the HTML to be shown to the user

public void renderChangePasswordSuccessful (MarkupOutput out)

Render the HTML corresponding to this transform for the ChangePasswordBean bean. By default, called by the transformForRequestSuccessful() method.

Parameters
out MarkupOutput instance where to save the HTML to be shown to the user.

public void renderExitChangePasswordPage (MarkupOutput out)

Render a message indicating the user where s/he is now connected to, if the information is available. Also, a link to take the user to another page, as indicated by the getDoneURLLink() method.

Parameters
out MarkupOutput where the resulting HTML to render will be saved

public void renderMissingFieldsError (MarkupOutput out, String errorField)

If error was found given missing information, this method displays the corresponding message. It will also display a link for allowing the user to return to a default page, indicated by the getDefaultEvent() method.

Parameters
out MarkupOutput instance where the output HTML will be placed
errorField Error field(s) that generated the error

public void renderSuccessfulMessage (MarkupOutput out)

Render a message to indicate the user's password has been changed. By default, it is the localized descriptor corresponding to Your password has been changed.

Parameters
out MarkupOutput where the resulting HTML to render will be saved

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by assigning a default URL information to the anchor (based on the getDoneURLLink method) when event is not defined.

Parameters
event WebEvent instance from where to generate the anchor. If not provided, the url information assigned will come from the getDoneURLLink method.
Returns

protected String getArgumentName (WebEvent event, int argumentId)

Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.

Parameters
event WebEvent from where the argument name will be retrieved
argumentId int with the identifier of the argument to search for on the event
Returns
  • the corresponding name of the event for the specified id. If it is not found, it will return null.

protected WebEvent getCancelEvent ()

Returns a WebEvent instance of the event submitted when the user clicks on the Cancel button.

Returns
  • WebEvent instance for the Cancel button.

protected WebEvent getChangePasswordEvent (ChangePasswordBean bean)

Based on the information available on the bean, generate the event that will be used for allowing the user to change the password

Parameters
bean ChangePasswordBean instance currently being transformed
Returns
  • a WebEvent for the change password action. It will return null if none could be generated.

protected WebEvent getDefaultEvent (ChangePasswordBean bean)

Get the WebEvent that will be shown to the user once the password has been changed. Typically, after the password is changed, the user is already logged into a project (except if the Administrator requested Login First), so this event shall take the user to the Start Page of that project.

Parameters
bean ChangePasswordBean instance currently being transformed
Returns
  • the WebEvent to use for the link to display the user, where s/he will be taken to after the password has been changed. Returns null if the application does not support the event.

protected String getDoneURLLink (ChangePasswordBean bean)

Determines the URL to use for indicating where to take the user once the password has been changed. By default, if the bean already specifies the target, that's the link to be used. Otherwise, it will use the URL information provided by the Default Event (getDefaultEvent() method call)

Parameters
bean ChangePasswordBean instance currently being transformed
Returns
  • the URL information to use for the link to show to the user after the password has been changed. Returns a null if it could not be calculated.