public class

LogoutTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.LogoutTransform

Class Overview

This transform renders the logout dialog to the user.

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
LogoutTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderErrorMessage(MarkupOutput out, String message)
Render the given message as a problem while performing log out.
void renderErrorMessage(MarkupOutput out)
Render the given message as a problem while performing log out.
void renderExitLogoutPage(MarkupOutput out)
Render a form button to take the user to the location specified by the getAfterLogoutEvent() method, after the logout has been performed.
void renderLogoutMessage(MarkupOutput out)
Render a message to indicate the user s/he has been logged out.
void renderLogoutTitle(MarkupOutput out)
Render the title for the message this transform will be showing to the user.
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the LogoutBean instance being transformed, when it's state is successful.
Protected Methods
WebEvent getAfterLogoutEvent()
Generate the WebEvent that will indicate where to take the user once the logout is completed.
[Expand]
Inherited Methods
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public LogoutTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports LogoutBean instances

Returns
  • LogoutBean.class

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public void renderErrorMessage (MarkupOutput out, String message)

Render the given message as a problem while performing log out.

Parameters
out MarkupOutput where the resulting HTML to render will be saved
message a String with the specific message to show to the user, indicating any errors while logging out

public void renderErrorMessage (MarkupOutput out)

Render the given message as a problem while performing log out.

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

public void renderExitLogoutPage (MarkupOutput out)

Render a form button to take the user to the location specified by the getAfterLogoutEvent() method, after the logout has been performed.

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

public void renderLogoutMessage (MarkupOutput out)

Render a message to indicate the user s/he has been logged out.

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

public void renderLogoutTitle (MarkupOutput out)

Render the title for the message this transform will be showing to the user.

Parameters
out MarkupOutput instance where the HTML content to display will be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the LogoutBean instance being transformed, when it's state is successful.

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected WebEvent getAfterLogoutEvent ()

Generate the WebEvent that will indicate where to take the user once the logout is completed. This event information is used as argument for the renderExitLogoutPage method.

Returns
  • a WebEvent instance for opening the home or welcome page of the application, or where the user should be taken to after the logout is completed. Returns null if the application does not support it.