public class

ReportDetailsXHTMLTransform

extends AbstractReportTransform
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.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.ReportDetailsXHTMLTransform

Class Overview

This transform is used to show details of a report. It has details like report name, report path, report SQL, report filters and some other things.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Constants
int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC
int DISPLAY_DYNAMIC_DATES_AS_STATIC
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
int LEVEL_ALL This constant is deprecated. please use the layout xml instead Value = 0xfffffff
int LEVEL_BASE_FILTER_NAME This constant is deprecated. please use the layout xml instead Value = 33554432
int LEVEL_COLUMN_COUNT This constant is deprecated. please use the layout xml instead Value = 256
int LEVEL_DESCRIPTION This constant is deprecated. please use the layout xml instead
int LEVEL_ENABLE_TOGGLE_ADVANCED_DETAILS This constant is deprecated. please use the layout xml instead Value = 67108864
int LEVEL_FINISH_TIME This constant is deprecated. please use the layout xml instead Value = 32768
int LEVEL_ID This constant is deprecated. please use the layout xml instead
int LEVEL_JOB_ID This constant is deprecated. please use the layout xml instead Value = 268435456
int LEVEL_MESSAGE_CREATED This constant is deprecated. please use the layout xml instead Value = 4096
int LEVEL_MESSAGE_ID This constant is deprecated. please use the layout xml instead Value = 65536
int LEVEL_MESSAGE_UPDATED This constant is deprecated. please use the layout xml instead Value = 8192
int LEVEL_MODIFIED This constant is deprecated. please use the layout xml instead Value = 134217728
int LEVEL_NAME This constant is deprecated. please use the layout xml instead
int LEVEL_OWNER This constant is deprecated. please use the layout xml instead
int LEVEL_PATH This constant is deprecated. please use the layout xml instead
int LEVEL_PROMPT_DETAILS This constant is deprecated. please use the layout xml instead Value = 8388608
int LEVEL_REPORT_DESCRIPTION This constant is deprecated. please use the layout xml instead Value = 536870912
int LEVEL_REPORT_FILTER This constant is deprecated. please use the layout xml instead Value = 524288
int LEVEL_REPORT_LIMIT This constant is deprecated. please use the layout xml instead Value = 131072
int LEVEL_REPORT_SQL This constant is deprecated. please use the layout xml instead Value = 16777216
int LEVEL_REPORT_TYPE This constant is deprecated. please use the layout xml instead Value = 1024
int LEVEL_ROW_COUNT This constant is deprecated. please use the layout xml instead
int LEVEL_SERVER_NAME This constant is deprecated. please use the layout xml instead
int LEVEL_START_TIME This constant is deprecated. please use the layout xml instead Value = 16384
int LEVEL_STATUS This constant is deprecated. please use the layout xml instead Value = 512
int LEVEL_TEMPLATE_DETAILS This constant is deprecated. please use the layout xml instead Value = 4194304
int LEVEL_TEMPLATE_NAME This constant is deprecated. please use the layout xml instead Value = 262144
int LEVEL_VIEW_FILTER This constant is deprecated. please use the layout xml instead Value = 1048576
String TEMPLATE_DETAILS_ATTRIBUTES Key for the template details to identify attribute information
String TEMPLATE_DETAILS_METRICS Key for the template details to identify metric information
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter dynamicDateDisplay
public FormalParameter expandEmbeddedFilter This is the formal parameter which will decide if we want to show the embedded filter details or just the embedded filter names.
public FormalParameter levelFlag This field is deprecated. please use the layout xml instead
public FormalParameter reportDetailsTxtAreaCols Parameter to specify the number of columns for the Report Details TEXTAREA.
public FormalParameter reportDetailsTxtAreaRows Parameter to specify the number of rows for the Report Details TEXTAREA.
public FormalParameter reportPathStylePara Parameter to specify the Style name used to show the report path.
public FormalParameter sqlTxtAreaCols Parameter to specify the number of columns for the SQL Textarea.
public FormalParameter sqlTxtAreaRows Parameter to specify the number of rows for the SQL Textarea.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportDetailsXHTMLTransform()
Default no-args constructor
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform by returning always true.
boolean checkLevel(int level)
This method is deprecated. use layout xml instead.
String getAdvancedDivId()
Generate the id of the div that holds the advanced detail information.
String getCssClassName(String cssName)
Generate the css class name used by this transform.
String getDescription()
Returns the description for this Transform
String getEncodedMessageID()
Get the message identifier then encrypt it form layout.
String getEncodedReportID()
Get the identifier information after encoded.
String getFinishTime()
Get the finish time from the ReportBean being displayed.
String getJobID()
Get the job identifier from ReportBean being displayed.
String getMessageCreationTime()
Get the message creation time from the ReportBean being displayed
String getMessageID()
Get the message identifier from the ReportBean.
String getMessageModificationTime()
Get the message modification time from the ReportBean being displayed.
String getModifiedInformation()
Get the modification information from the ReportBean being displayed
String getReportCube()
Get the report cube for the ReportBean being displayed
String getReportDescription()
Get the report description from the ReportBean being displayed
Map getReportDetailAttrs()
Collect all the attribute/value(s) to specify the rendering of the report detail text area.
String getReportDetails()
Get report details from the ReportBean being displayed.
String getReportID()
Get the identifier information from the ReportBean being displayed.
String getReportOwner()
Get report owner information from the ReportBean being displayed
String getReportSQL()
Get report SQL from the ReportBean being displayed.
String getReportSQLLabel()
Get the report SQL label based on report type.
String getReportStatus(int status)
Extends getReportStatus() by providing custom message for some status
String getReportStatus()
Get the status information from the ReportBean being displayed
String getReportType()
Get the report type from the ReportBean being displayed.
String getServerName()
Get the server name form the ReportBean.
String getStartTime()
Get the start time from the ReportBean being displayed.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
int getTotalColumns()
Get the total number of columns information from the ReportBean.
int getTotalRows()
Get the total number of rows information from the ReportBean.
WebEvent getWebReexecuteEvent()
Returns a WebEvent instance corresponding to the reexecute event
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isReportAdvancedAreaExpanded()
Determines based on the formal parameter if the advanced report information are is requested to be expanded or not
boolean isReportAdvancedAreaVisible()
This method is deprecated. please use the layout xml instead.
boolean isReportDetailsAreaVisible()
This method is deprecated. use layout xml instead.
boolean isReportInError()
Check to see if the report is in error or not.
boolean isReportReady()
void renderAdvancedAreaJavaScript(MarkupOutput out)
Renders JavaScript (if any) that will be related with the advanced information area for the report.
void renderAdvancedDetailsButton(MarkupOutput out)
Render the button that will allow users to show or not the advanced details information about the report.
void renderAdvancedDetailsButton(MarkupOutput out, boolean requestExpand)
Render the button that will allow users to show or not the advanced details information about the report.
void renderFinishTime(MarkupOutput out)
Render the finish time information of the ReportBean being displayed
void renderJobID(MarkupOutput out)
Render the job identifier information of the ReportBean being displayed
void renderMessageCreated(MarkupOutput out)
Render the message created information of the ReportBean being displayed
void renderMessageID(MarkupOutput out)
Render the message identifier information of the ReportBean being displayed
void renderMessageUpdated(MarkupOutput out)
Render the message updated information of the ReportBean being displayed
void renderModifiedInformation(MarkupOutput out)
Render the modification information of the ReportBean being displayed
void renderNewLine(MarkupOutput out)
Render a new line character.
void renderPromptSummaryAnswerInformation(MarkupOutput out)
Render the prompt summary information of the ReportBean being displayed
void renderReportDescription(MarkupOutput out)
Render the description information of the ReportBean being displayed
void renderReportDetails(MarkupOutput out)
render new report details.
void renderReportFilterInformation(MarkupOutput out)
Render the report filter information of the ReportBean being displayed
void renderReportID(MarkupOutput out)
Render the identifier information of the ReportBean being displayed
void renderReportLimitInformation(MarkupOutput out)
Render the report limit information of the ReportBean being displayed
void renderReportName(MarkupOutput out)
Render the name information of the ReportBean being displayed
void renderReportOwner(MarkupOutput out)
Render the report owner information of the ReportBean being displayed
void renderReportPath(MarkupOutput out)
Render the path location information of the ReportBean being displayed
void renderReportSQL(MarkupOutput out)
Render the SQL information of the ReportBean being displayed
void renderReportStatus(MarkupOutput out)
Render the status information of the ReportBean being displayed
void renderReportType(MarkupOutput out)
Render the report type information of the ReportBean being displayed
void renderServerName(MarkupOutput out)
Render the server name information of the ReportBean being displayed
void renderStartTime(MarkupOutput out)
Render the start time information of the ReportBean being displayed
void renderTemplateDetailsInformation(MarkupOutput out)
Render the template details information of the ReportBean being displayed
void renderTemplateNameInformation(MarkupOutput out)
Render the template name information of the ReportBean being displayed
void renderTotalColumns(MarkupOutput out)
Render the total columns information of the ReportBean being displayed
void renderTotalRows(MarkupOutput out)
Render the total rows information of the ReportBean being displayed
void renderViewFilterInformation(MarkupOutput out)
Render the view filter information of the ReportBean being displayed
boolean shouldRenderAdvancedAreaExpanded()
check to see if advanced area should be rendered as expanded or not.
boolean shouldRenderPromptDetails()
Check to see if prompt details should be rendered or not.
boolean shouldRenderTemplate()
This method is deprecated. use layout xml instead.
void transformForRequestInError(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "Error".
void transformForRequestProcessing(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing).
void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status which is transformed by this transform is "Successful".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)".
Protected Methods
WebEvent getExecuteEvent(WebMessage message)
Returns an event to execute the report.
WebMessage getReportMessage()
TransformInstance getReportPathTransform(ReportBean rb)
This method is deprecated. not used anymore
WebEvent getShowDetailsEvent(WebMessage message)
Generate the WebEvent instance to be used for showing the details of the report (to refresh the page information).
void getTemplateDetails(Hashtable templateDetails)
Obtain from the ReportBean instance the template details information
void initializeReportMessage()
Obtains the WebMessage instance out of the ReportBean being transformed, for initializing the property of this transform.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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

Constants

public static final int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC

Constant Value: 1 (0x00000001)

public static final int DISPLAY_DYNAMIC_DATES_AS_STATIC

Constant Value: 0 (0x00000000)

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final int LEVEL_ALL

This constant is deprecated.
please use the layout xml instead Value = 0xfffffff

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.

Constant Value: 268435455 (0x0fffffff)

public static final int LEVEL_BASE_FILTER_NAME

This constant is deprecated.
please use the layout xml instead Value = 33554432

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's filter name.

Constant Value: 33554432 (0x02000000)

public static final int LEVEL_COLUMN_COUNT

This constant is deprecated.
please use the layout xml instead Value = 256

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's column count information.

Constant Value: 256 (0x00000100)

public static final int LEVEL_DESCRIPTION

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's description.
Value = 2

Constant Value: 2 (0x00000002)

public static final int LEVEL_ENABLE_TOGGLE_ADVANCED_DETAILS

This constant is deprecated.
please use the layout xml instead Value = 67108864

Allowed value for the levelFlag formal parameter. Specifies that the transform will display a button for showing or hiding advanced details.

Constant Value: 67108864 (0x04000000)

public static final int LEVEL_FINISH_TIME

This constant is deprecated.
please use the layout xml instead Value = 32768

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's finish time information.

Constant Value: 32768 (0x00008000)

public static final int LEVEL_ID

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's identifier.
Value = 8

Constant Value: 8 (0x00000008)

public static final int LEVEL_JOB_ID

This constant is deprecated.
please use the layout xml instead Value = 268435456

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's job identifier information.

Constant Value: 268435456 (0x10000000)

public static final int LEVEL_MESSAGE_CREATED

This constant is deprecated.
please use the layout xml instead Value = 4096

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message created information.

Constant Value: 4096 (0x00001000)

public static final int LEVEL_MESSAGE_ID

This constant is deprecated.
please use the layout xml instead Value = 65536

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message identifier information.

Constant Value: 65536 (0x00010000)

public static final int LEVEL_MESSAGE_UPDATED

This constant is deprecated.
please use the layout xml instead Value = 8192

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message updated information.

Constant Value: 8192 (0x00002000)

public static final int LEVEL_MODIFIED

This constant is deprecated.
please use the layout xml instead Value = 134217728

Allowed value for the levelFlag formal parameter. Specifies that the transform will display report's modified information.

Constant Value: 134217728 (0x08000000)

public static final int LEVEL_NAME

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's name.
Value = 1

Constant Value: 1 (0x00000001)

public static final int LEVEL_OWNER

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's owner.
Value = 4

Constant Value: 4 (0x00000004)

public static final int LEVEL_PATH

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the path information of where the object is.
Value = 64

Constant Value: 64 (0x00000040)

public static final int LEVEL_PROMPT_DETAILS

This constant is deprecated.
please use the layout xml instead Value = 8388608

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's prompt information.

Constant Value: 8388608 (0x00800000)

public static final int LEVEL_REPORT_DESCRIPTION

This constant is deprecated.
please use the layout xml instead Value = 536870912

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the report description.

Constant Value: 536870912 (0x20000000)

public static final int LEVEL_REPORT_FILTER

This constant is deprecated.
please use the layout xml instead Value = 524288

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's report filter information.

Constant Value: 524288 (0x00080000)

public static final int LEVEL_REPORT_LIMIT

This constant is deprecated.
please use the layout xml instead Value = 131072

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's limit information.

Constant Value: 131072 (0x00020000)

public static final int LEVEL_REPORT_SQL

This constant is deprecated.
please use the layout xml instead Value = 16777216

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's SQL information.

Constant Value: 16777216 (0x01000000)

public static final int LEVEL_REPORT_TYPE

This constant is deprecated.
please use the layout xml instead Value = 1024

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's report type.

Constant Value: 1024 (0x00000400)

public static final int LEVEL_ROW_COUNT

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's row count information.
Value = 128

Constant Value: 128 (0x00000080)

public static final int LEVEL_SERVER_NAME

This constant is deprecated.
please use the layout xml instead

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the name of the server where the object is located.
Value = 32

Constant Value: 32 (0x00000020)

public static final int LEVEL_START_TIME

This constant is deprecated.
please use the layout xml instead Value = 16384

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's start time information.

Constant Value: 16384 (0x00004000)

public static final int LEVEL_STATUS

This constant is deprecated.
please use the layout xml instead Value = 512

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's status information.

Constant Value: 512 (0x00000200)

public static final int LEVEL_TEMPLATE_DETAILS

This constant is deprecated.
please use the layout xml instead Value = 4194304

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's template details.

Constant Value: 4194304 (0x00400000)

public static final int LEVEL_TEMPLATE_NAME

This constant is deprecated.
please use the layout xml instead Value = 262144

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's template name.

Constant Value: 262144 (0x00040000)

public static final int LEVEL_VIEW_FILTER

This constant is deprecated.
please use the layout xml instead Value = 1048576

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's view filter information.

Constant Value: 1048576 (0x00100000)

protected static final String TEMPLATE_DETAILS_ATTRIBUTES

Key for the template details to identify attribute information

Constant Value: "ATTRIBUTES"

protected static final String TEMPLATE_DETAILS_METRICS

Key for the template details to identify metric information

Constant Value: "METRICS"

Fields

public FormalParameter dynamicDateDisplay

public FormalParameter expandEmbeddedFilter

This is the formal parameter which will decide if we want to show the embedded filter details or just the embedded filter names.
Allowed Values: TRUE/FALSE

public FormalParameter levelFlag

This field is deprecated.
please use the layout xml instead

Indicates the level of information to use when displaying the report details.
The information may include object name, description, row count, sql details and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_NAME, LEVEL_DESCRIPTION, LEVEL_OWNER, etc.
Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is LEVEL_ALL

public FormalParameter reportDetailsTxtAreaCols

Parameter to specify the number of columns for the Report Details TEXTAREA.
Allowed Values: any integer value

public FormalParameter reportDetailsTxtAreaRows

Parameter to specify the number of rows for the Report Details TEXTAREA.
Allowed Values: any integer value

public FormalParameter reportPathStylePara

Parameter to specify the Style name used to show the report path. This has to match one of the styles specified in the page config file.
Allowed Values: any report style name from StyelCatalog.xml file.

public FormalParameter sqlTxtAreaCols

Parameter to specify the number of columns for the SQL Textarea.
Allowed Values: integer values

public FormalParameter sqlTxtAreaRows

Parameter to specify the number of rows for the SQL Textarea.
Allowed Values: integer values

Public Constructors

public ReportDetailsXHTMLTransform ()

Default no-args constructor

Public Methods

public boolean canTransform (Transformable data)

Overrides canTransform by returning always true. This transform does support showing report details, even if still waiting for prompts.

Parameters
data the report bean that will transformed.
Returns
  • true if the data is a ReportBean.

public boolean checkLevel (int level)

This method is deprecated.
use layout xml instead.

Check if the level parameter value contains this flag. This method calls checkLevel(FormalParameter, int) using the levelFlag parameter

Parameters
level flag value to check
Returns
  • true means the level flag is included in the levelFlag formal parameter value

public String getAdvancedDivId ()

Generate the id of the div that holds the advanced detail information.

Returns
  • the id

public String getCssClassName (String cssName)

Generate the css class name used by this transform.

Parameters
cssName the css name to be pre-fixed by the _cssPrefix
Returns
  • complete cssName

public String getDescription ()

Returns the description for this Transform

Returns
  • Description for this Transform

public String getEncodedMessageID ()

Get the message identifier then encrypt it form layout.

Returns
  • the message identifier

public String getEncodedReportID ()

Get the identifier information after encoded.

Returns
  • identifier

public String getFinishTime ()

Get the finish time from the ReportBean being displayed.

Returns
  • the finish time

public String getJobID ()

Get the job identifier from ReportBean being displayed.

Returns
  • the job identifier

public String getMessageCreationTime ()

Get the message creation time from the ReportBean being displayed

Returns
  • the message creation time

public String getMessageID ()

Get the message identifier from the ReportBean.

Returns
  • the message identifier

public String getMessageModificationTime ()

Get the message modification time from the ReportBean being displayed.

Returns
  • the message modification time

public String getModifiedInformation ()

Get the modification information from the ReportBean being displayed

Returns
  • the modification time

public String getReportCube ()

Get the report cube for the ReportBean being displayed

Returns
  • the report description

public String getReportDescription ()

Get the report description from the ReportBean being displayed

Returns
  • the report description

public Map getReportDetailAttrs ()

Collect all the attribute/value(s) to specify the rendering of the report detail text area.

Returns
  • the attribute/value pair(s)

public String getReportDetails ()

Get report details from the ReportBean being displayed.

Returns
  • the report detail string

public String getReportID ()

Get the identifier information from the ReportBean being displayed.

Returns
  • identifier

public String getReportOwner ()

Get report owner information from the ReportBean being displayed

Returns
  • the report owner

public String getReportSQL ()

Get report SQL from the ReportBean being displayed.

Returns
  • the report SQL

public String getReportSQLLabel ()

Get the report SQL label based on report type.

Returns
  • the label for report SQL area

public String getReportStatus (int status)

Extends getReportStatus() by providing custom message for some status

Parameters
status The WebMessage instance current status
Returns
  • a string description of the status of the message

public String getReportStatus ()

Get the status information from the ReportBean being displayed

Returns
  • the report status

public String getReportType ()

Get the report type from the ReportBean being displayed.

Returns
  • the report type

public String getServerName ()

Get the server name form the ReportBean.

Returns
  • the server name

public String getStartTime ()

Get the start time from the ReportBean being displayed.

Returns
  • the start time

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public int getTotalColumns ()

Get the total number of columns information from the ReportBean.

Returns
  • the total number of columns
Throws
WebBeanException
WebBeanException

public int getTotalRows ()

Get the total number of rows information from the ReportBean.

Returns
  • the total number of rows
Throws
WebBeanException
WebBeanException

public WebEvent getWebReexecuteEvent ()

Returns a WebEvent instance corresponding to the reexecute event

Returns
  • the web reexecute event

public void initializeTransform (Transformable data)

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

Parameters
data the bean to transform.

public boolean isReportAdvancedAreaExpanded ()

Determines based on the formal parameter if the advanced report information are is requested to be expanded or not

Returns
  • boolean value indicating if the advanced report details area should be shown to the user.

public boolean isReportAdvancedAreaVisible ()

This method is deprecated.
please use the layout xml instead.

Indicates if the Report Advanced Details section is to be rendered or not. It will depend if at least one of the sections taht go on it is requested by the user. By default, any of these should be rendered for the Advanced area to be visible: row count, column count, server name, message identifier, report identifier, message created, message updated and/or level status.

Returns
  • boolean value indicating if the Advanced section should be rendered or not.

public boolean isReportDetailsAreaVisible ()

This method is deprecated.
use layout xml instead.

Indicates if the report details section is to be rendered or not. It will depend if at least one of the sections that go on it is requested by the user. By default, any of these should be rendered for the Report Details area to be visible: report filter, template name, template details, view filter, report limit and/or prompt details.

Returns
  • boolean value indicating if the Report Details section should be rendered or not.

public boolean isReportInError ()

Check to see if the report is in error or not.

Returns
  • true if error occurs; false otherwise

public boolean isReportReady ()

public void renderAdvancedAreaJavaScript (MarkupOutput out)

Renders JavaScript (if any) that will be related with the advanced information area for the report. In this case is for enabling showing and hiding the details.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderAdvancedDetailsButton (MarkupOutput out)

Render the button that will allow users to show or not the advanced details information about the report.

Parameters
out the MarkupOutput object

public void renderAdvancedDetailsButton (MarkupOutput out, boolean requestExpand)

Render the button that will allow users to show or not the advanced details information about the report.

Parameters
out the MarkupOutput instance where the contents of this transform will be saved
requestExpand whether the button will be rendered as already expanded or not

public void renderFinishTime (MarkupOutput out)

Render the finish time information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderJobID (MarkupOutput out)

Render the job identifier information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderMessageCreated (MarkupOutput out)

Render the message created information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderMessageID (MarkupOutput out)

Render the message identifier information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderMessageUpdated (MarkupOutput out)

Render the message updated information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderModifiedInformation (MarkupOutput out)

Render the modification information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderNewLine (MarkupOutput out)

Render a new line character.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderPromptSummaryAnswerInformation (MarkupOutput out)

Render the prompt summary information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportDescription (MarkupOutput out)

Render the description information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportDetails (MarkupOutput out)

render new report details.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportFilterInformation (MarkupOutput out)

Render the report filter information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportID (MarkupOutput out)

Render the identifier information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportLimitInformation (MarkupOutput out)

Render the report limit information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportName (MarkupOutput out)

Render the name information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportOwner (MarkupOutput out)

Render the report owner information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportPath (MarkupOutput out)

Render the path location information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportSQL (MarkupOutput out)

Render the SQL information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportStatus (MarkupOutput out)

Render the status information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderReportType (MarkupOutput out)

Render the report type information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderServerName (MarkupOutput out)

Render the server name information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderStartTime (MarkupOutput out)

Render the start time information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderTemplateDetailsInformation (MarkupOutput out)

Render the template details information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderTemplateNameInformation (MarkupOutput out)

Render the template name information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderTotalColumns (MarkupOutput out)

Render the total columns information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderTotalRows (MarkupOutput out)

Render the total rows information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderViewFilterInformation (MarkupOutput out)

Render the view filter information of the ReportBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public boolean shouldRenderAdvancedAreaExpanded ()

check to see if advanced area should be rendered as expanded or not.

Returns
  • true if necessary;false otherwise

public boolean shouldRenderPromptDetails ()

Check to see if prompt details should be rendered or not.

Returns
  • true if necessary;false otherwise

public boolean shouldRenderTemplate ()

This method is deprecated.
use layout xml instead.

Check to see if we should render template.

Returns
  • true if render if necessary; false otherwise.

public void transformForRequestInError (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "Error".

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestProcessing (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing). Just forwards to the successful transform;

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the bean status which is transformed by this transform is "Successful".

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)". Just forwards to the successful transform;

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

Protected Methods

protected WebEvent getExecuteEvent (WebMessage message)

Returns an event to execute the report.

Parameters
message the (@link WebMessage} for the ReportBean beings displayed.
Returns
  • a WebEvent instance to execute the report message. By default it returns the REPORT_EVENT_EXECUTE event, or null if it is not supported by the application

protected WebMessage getReportMessage ()

Returns

protected TransformInstance getReportPathTransform (ReportBean rb)

This method is deprecated.
not used anymore

protected WebEvent getShowDetailsEvent (WebMessage message)

Generate the WebEvent instance to be used for showing the details of the report (to refresh the page information).

Parameters
message the (@link WebMessage} for the ReportBean beings displayed.
Returns

protected void getTemplateDetails (Hashtable templateDetails)

Obtain from the ReportBean instance the template details information

Parameters
templateDetails Hashtable initialized instance where the information about the template will be saved using the TEMPLATE_DETAILS_METRICS and TEMPLATE_DETAILS_ATTRIBUTES

protected void initializeReportMessage ()

Obtains the WebMessage instance out of the ReportBean being transformed, for initializing the property of this transform.

Throws
WebBeanException} if any error happens while initializing the information
WebObjectsException} if any error happens while initializing the information
WebBeanException
WebObjectsException