public class

ReportDetailsTransform

extends AbstractReportTransform
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.ReportDetailsTransform

This class is deprecated.
Use ReportDetailsXHTMLTransform instead.

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.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String cssReportFilterHeader
protected String cssReportFilterTable
protected String cssReportFilterTextArea
protected String cssReportNameProperty
protected String cssReportNameTable
protected String cssReportNameValue
protected String cssReportPromptHeader
protected String cssReportPromptTable
protected String cssReportPropertyName
protected String cssReportPropertyValue
protected String cssReportSQLHeader
protected String cssReportSQLTable
protected String cssReportSQLTextArea
protected String cssReportTemplateDetailsHeader
protected String cssReportTemplateDetailsTable
protected String cssReportTemplateDetailsTextArea
protected String cssReportViewFilterHeader
protected String cssReportViewFilterTable
protected String cssReportViewFilterTextArea
protected FormalParameter expandEmbeddedFilter Indicates whether or not to show simply the shortcut name or the expanded expression.
protected FormalParameter isDataSet This is the formal parameter which indicates if the object being displayed corresponds to a Data Set object or not.
protected FormalParameter reportFilterTxtAreaCols Parameter to specify the number of columns for the Report Filter Textarea.
protected FormalParameter reportFilterTxtAreaRows Parameter to specify the number of rows for the Report Filter Textarea.
protected FormalParameter reportPathStylePara Parameter to specify the Style name used to show the report path.
protected FormalParameter reportPromptDetailsStylePara Parameter to specify the Style name used to show the prompt details.
protected FormalParameter showHRLine1Para Flag used to decide if we need to show the first HR on the transform.
protected FormalParameter showHRLine2Para Flag used to decide if we need to show the second HR on the transform.
protected FormalParameter showHRLine3Para Flag used to decide if we need to show the third HR on the transform.
protected FormalParameter showParentFolderPara Flag used to decide if we need to show Report Parent Folder Name.
protected FormalParameter showReportBaseFilterNamePara Flag used to decide if we need to show the Report Base Filter name.
protected FormalParameter showReportDescriptionPara Flag used to decide if we need to show the Report Description.
protected FormalParameter showReportFilterPara Flag used to decide if we need to show the Report Filter details.
protected FormalParameter showReportFinishTimePara Flag used to decide if we need to show the Report Finish time.
protected FormalParameter showReportIDPara Flag used to decide if we need to show the total ReportID.
protected FormalParameter showReportLimitPara Flag used to decide if we need to show the Report Template Limit.
protected FormalParameter showReportMessageCreatedPara Flag used to decide if we need to show the Report Message Created time.
protected FormalParameter showReportMessagePara Flag used to decide if we need to show the Report MessageID.
protected FormalParameter showReportMessageUpdatedPara Flag used to decide if we need to show the Report Message Updated time.
protected FormalParameter showReportNamePara Flag used to decide if we need to show Report Name.
protected FormalParameter showReportOwnerPara Flag used to decide if we need to show the Report Owner.
protected FormalParameter showReportPathPara Flag used to decide if we need to show the Report Path.
protected FormalParameter showReportPromptDetailsPara Flag used to decide if we need to show the Report Prompt details.
protected FormalParameter showReportSQLPara Flag used to decide if we need to show the Report SQL details.
protected FormalParameter showReportStartTimePara Flag used to decide if we need to show the Report Start time.
protected FormalParameter showReportStatusPara Flag used to decide if we need to show the Report Status.
protected FormalParameter showReportTemplateDetailsPara Flag used to decide if we need to show the Report Template details.
protected FormalParameter showReportTemplatePara Flag used to decide if we need to show the Report Template name.
protected FormalParameter showReportTotColsPara Flag used to decide if we need to show the total columns in the report.
protected FormalParameter showReportTotRowsPara Flag used to decide if we need to show the total rows in the report.
protected FormalParameter showReportViewFilterPara Flag used to decide if we need to show the Report View Filter details.
protected FormalParameter showServerNamePara Flag used to decide if we need to show the Server Name.
protected FormalParameter sqlTxtAreaCols Parameter to specify the number of columns for the SQL Textarea.
protected FormalParameter sqlTxtAreaRows Parameter to specify the number of rows for the SQL Textarea.
protected FormalParameter templateDetailsTxtAreaCols Parameter to specify the number of columns for the Template Details Textarea.
protected FormalParameter templateDetailsTxtAreaRows Parameter to specify the number of rows for the Template Details Textarea.
protected FormalParameter viewFilterTxtAreaCols Parameter to specify the number of columns for the View Filter Textarea.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportDetailsTransform()
Default no-args constructor
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform by returning always true.
String getDescription()
Returns the description for this Transform
String getReportStatus(int status)
Extends getReportStatus() by providing custom message for some status
Class getSupportedBeanType()
return the bean type supported by this transform.
void initializeCss()
Initialize the css classes to be used by this transform.
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 "Successfull".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)".
Protected Methods
void getTemplateDetails(Hashtable templateDetails)
This method will put two new Strings on the templateDetails table the keys will be "METRIC" and "ATTRIBUTE" The content of the METRICS string will be, for each metric, its name followed by the description in case that it is present otherwise the metric formula and the metric conditionality using the WebReportData.getMetricFormula and getMetricConditionality methods.
void renderFilterName(MarkupOutput out, WebMessage _wm)
Method will render the filter name if the formal parameter showReportBaseFilterNamePara is true, there is no error in the report as stated by the reportInError variable, base filter name retrieved from the reportBean data using the getBaseFilterName method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 645:"Filter:" and the second one the string that the returned by getBaseFilterName() HTML encoded
void renderFinishTime(MarkupOutput out, WebMessage _wm)
Method will render the modification time of the web message if the formal parameter showReportFinishTimePara is true, there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 655:"Finish Time:" and the second one the string that the method _wm.getRequestFinishTime() returns only if this is not null and the length is greater than zero HTML encoded, otherwise will render the message contained in the descriptor 3755:"Job is still running"
void renderMessageCreated(MarkupOutput out, WebMessage _wm)
Method will render the creation time of the web message if the formal parameter showReportMessageCreatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getCreationTime() is not null and _wm.getCreationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 652:"Message Created:" and the second one the string that the method _wm.getCreationTime() returns HTML encoded
void renderMessageID(MarkupOutput out, WebMessage _wm)
Method will render the message ID of the WebMessage _wm parameter if the formal parameter showReportMessagePara is true, the id of _wm, if _wm is not null and the id is not null and its length is greater than zero, or the reportBean messageID is not null and its length greater than zero.
void renderMessageUpdated(MarkupOutput out, WebMessage _wm)
Method will render the modification time of the web message if the formal parameter showReportMessageUpdatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getModificationTime() is not null and _wm.getModificationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 653:"Message last updated:" and the second one the string that the method _wm.getModificationTime() returns HTML encoded
void renderParentFolderName(MarkupOutput out, WebMessage _wm)
Will render the parent folder name if the showParentFolderPara formal parameter is true and there is no error in report as stated in the reportInError variable and the WebMessage.getFolderName method returns some string who its lenght is greater than 0 and not null.
void renderPromptDetails(MarkupOutput out, WebMessage _wm)
Method will render on the out variable a table with the descriptor 1309:"Prompt Details" and the result of the PromptsBean transform method using the style stated in the formal parameter reportPromptDetailsStylePara.
void renderReportDescription(MarkupOutput out, WebMessage _wm)
Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded
void renderReportFilter(MarkupOutput out, WebMessage _wm)
Method will render the report filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportFilterPara is true.
void renderReportID(MarkupOutput out, WebMessage _wm)
Method will render the object ID of the WebMessage _wm parameter if the formal parameter showReportIDPara is true, the object id of _wm, if _wm is not null and the object id is not null and its length is greater than zero, or the reportBean objectID is not null and its length greater than zero.
void renderReportLimit(MarkupOutput out, WebMessage _wm)
Method will render the report limit if the formal parameter showReportLimitPara is true, there is no error in the report as stated by the reportInError variable, the template limit retrieved from the reportBean data using the getTemplateLimit() method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 1121:"Report Limit:" and the second one the string that the returned by getTemplateLimit()
void renderReportName(MarkupOutput out, WebMessage _wm)
Will render a table with the report name as a link when the WebMessage is different of null and the report allows execution, plain text otherwise.
void renderReportOwner(MarkupOutput out, WebMessage _wm)
Method will render the report owner if the formal parameter showReportOwnerPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectCreator() is not null and _wm.getObjectCreator() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 60:"Owner:" and the second one the string that the method _wm.getObjectCreator() returns HTML encoded
void renderReportPath(MarkupOutput out, WebMessage _wm)
Method will render the report path if the formal parameter showReportPathPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 650:"Report path:" and the second one the report path string that the method getReportPath() returns
void renderReportSQL(MarkupOutput out, WebMessage _wm)
Will render the MDX statement if the report is a MDX report or the SQL statement of the report otherwise, will print the descriptor 1097:"The SQL generation is not complete" if the SQL is null or length zero
void renderReportStatus(MarkupOutput out, WebMessage _wm)
Method will render the report status if the formal parameter showReportStatusPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 187:"Status:" and the second one the string that the method getReportStatus(_wm.getRequestStatus()) returns
void renderServerName(MarkupOutput out, WebMessage _wm)
Method will render the number of server name if the formal parameter showServerNamePara is true, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 36:"Server Name:" and the second one the string that the method getServerName of the WebIServerSession class returns HTML encoded
void renderStartTime(MarkupOutput out, WebMessage _wm)
Method will render the modification time of the web message if the formal parameter showReportStartTimePara is true, there is no error in the report as stated by the reportInError variable, _wm.getRequestStartTime() is not null and _wm.getRequestStartTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 188:"Start time:" and the second one the string that the method _wm.getRequestStartTime() returns
void renderTemplateDetails(MarkupOutput out, WebMessage _wm)
Will render the template details if the reportInError variable is false and the template details txt area rows and the template details txt area cols, the template details metrics and attributes.
void renderTemplateName(MarkupOutput out, WebMessage _wm)
Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded
void renderTotalColumns(MarkupOutput out, WebMessage _wm)
Method will render the number of total columns in the report if the formal parameter showReportTotColsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 649:"Total number of columns:" and the second one the totalColumns that the method getGridTotalColumns of the WebReportData class returns
void renderTotalRows(MarkupOutput out, WebMessage _wm)
Method will render the number of total rows in the report if the formal parameter showReportTotRowsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 648:"Total number of rows:" and the second one the totalRows that the method getGridTotalRows of the WebReportData class returns
void renderViewFilter(MarkupOutput out, WebMessage _wm)
Method will render the view filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportViewFilterPara is true.
[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.Transform

Fields

protected String cssReportFilterHeader

protected String cssReportFilterTable

protected String cssReportFilterTextArea

protected String cssReportNameProperty

protected String cssReportNameTable

protected String cssReportNameValue

protected String cssReportPromptHeader

protected String cssReportPromptTable

protected String cssReportPropertyName

protected String cssReportPropertyValue

protected String cssReportSQLHeader

protected String cssReportSQLTable

protected String cssReportSQLTextArea

protected String cssReportTemplateDetailsHeader

protected String cssReportTemplateDetailsTable

protected String cssReportTemplateDetailsTextArea

protected String cssReportViewFilterHeader

protected String cssReportViewFilterTable

protected String cssReportViewFilterTextArea

protected FormalParameter expandEmbeddedFilter

Indicates whether or not to show simply the shortcut name or the expanded expression.

protected FormalParameter isDataSet

This is the formal parameter which indicates if the object being displayed corresponds to a Data Set object or not.
Allowed Values: TRUE/FALSE
@deprecated

protected FormalParameter reportFilterTxtAreaCols

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

protected FormalParameter reportFilterTxtAreaRows

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

protected 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.

protected FormalParameter reportPromptDetailsStylePara

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

protected FormalParameter showHRLine1Para

Flag used to decide if we need to show the first HR on the transform.
Allowed Values: TRUE / FALSE

protected FormalParameter showHRLine2Para

Flag used to decide if we need to show the second HR on the transform.
Allowed Values: TRUE / FALSE

protected FormalParameter showHRLine3Para

Flag used to decide if we need to show the third HR on the transform.
Allowed Values: TRUE / FALSE

protected FormalParameter showParentFolderPara

Flag used to decide if we need to show Report Parent Folder Name.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportBaseFilterNamePara

Flag used to decide if we need to show the Report Base Filter name.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportDescriptionPara

Flag used to decide if we need to show the Report Description.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportFilterPara

Flag used to decide if we need to show the Report Filter details.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportFinishTimePara

Flag used to decide if we need to show the Report Finish time.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportIDPara

Flag used to decide if we need to show the total ReportID.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportLimitPara

Flag used to decide if we need to show the Report Template Limit.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportMessageCreatedPara

Flag used to decide if we need to show the Report Message Created time.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportMessagePara

Flag used to decide if we need to show the Report MessageID.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportMessageUpdatedPara

Flag used to decide if we need to show the Report Message Updated time.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportNamePara

Flag used to decide if we need to show Report Name.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportOwnerPara

Flag used to decide if we need to show the Report Owner.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportPathPara

Flag used to decide if we need to show the Report Path.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportPromptDetailsPara

Flag used to decide if we need to show the Report Prompt details.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportSQLPara

Flag used to decide if we need to show the Report SQL details.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportStartTimePara

Flag used to decide if we need to show the Report Start time.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportStatusPara

Flag used to decide if we need to show the Report Status.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportTemplateDetailsPara

Flag used to decide if we need to show the Report Template details.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportTemplatePara

Flag used to decide if we need to show the Report Template name.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportTotColsPara

Flag used to decide if we need to show the total columns in the report.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportTotRowsPara

Flag used to decide if we need to show the total rows in the report.
Allowed Values: TRUE / FALSE

protected FormalParameter showReportViewFilterPara

Flag used to decide if we need to show the Report View Filter details.
Allowed Values: TRUE / FALSE

protected FormalParameter showServerNamePara

Flag used to decide if we need to show the Server Name.
Allowed Values: TRUE / FALSE

protected FormalParameter sqlTxtAreaCols

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

protected FormalParameter sqlTxtAreaRows

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

protected FormalParameter templateDetailsTxtAreaCols

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

protected FormalParameter templateDetailsTxtAreaRows

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

protected FormalParameter viewFilterTxtAreaCols

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

Public Constructors

public ReportDetailsTransform ()

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 String getDescription ()

Returns the description for this Transform

Returns
  • Description for this Transform

public String getReportStatus (int status)

Extends getReportStatus() by providing custom message for some status

Parameters
status The message status
Returns
  • The string description of the status

public Class getSupportedBeanType ()

return the bean type supported by this transform.

Returns
  • the bean type

public void initializeCss ()

Initialize the css classes to be used by this transform.

public void transformForRequestInError (MarkupOutput out)

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

Parameters
out Output by this transform

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 "Successfull".

Parameters
out Output by this transform

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 successfull transform;

Parameters
out Output by this transform

Protected Methods

protected void getTemplateDetails (Hashtable templateDetails)

This method will put two new Strings on the templateDetails table the keys will be "METRIC" and "ATTRIBUTE" The content of the METRICS string will be, for each metric, its name followed by the description in case that it is present otherwise the metric formula and the metric conditionality using the WebReportData.getMetricFormula and getMetricConditionality methods. Ths content of the ATTRIBUTE string will be, for each attribute, the name followed by the description in the case that is present, otherwise the string contained on the descriptor 1131:"Information not available"

protected void renderFilterName (MarkupOutput out, WebMessage _wm)

Method will render the filter name if the formal parameter showReportBaseFilterNamePara is true, there is no error in the report as stated by the reportInError variable, base filter name retrieved from the reportBean data using the getBaseFilterName method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 645:"Filter:" and the second one the string that the returned by getBaseFilterName() HTML encoded

Parameters
_wm not used

protected void renderFinishTime (MarkupOutput out, WebMessage _wm)

Method will render the modification time of the web message if the formal parameter showReportFinishTimePara is true, there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 655:"Finish Time:" and the second one the string that the method _wm.getRequestFinishTime() returns only if this is not null and the length is greater than zero HTML encoded, otherwise will render the message contained in the descriptor 3755:"Job is still running"

protected void renderMessageCreated (MarkupOutput out, WebMessage _wm)

Method will render the creation time of the web message if the formal parameter showReportMessageCreatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getCreationTime() is not null and _wm.getCreationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 652:"Message Created:" and the second one the string that the method _wm.getCreationTime() returns HTML encoded

protected void renderMessageID (MarkupOutput out, WebMessage _wm)

Method will render the message ID of the WebMessage _wm parameter if the formal parameter showReportMessagePara is true, the id of _wm, if _wm is not null and the id is not null and its length is greater than zero, or the reportBean messageID is not null and its length greater than zero. This will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 80:"Message ID:" and the second one the _wm.getID() or the messageID of the report bean in the case that _vm and _vm.getID() are null or not valid

protected void renderMessageUpdated (MarkupOutput out, WebMessage _wm)

Method will render the modification time of the web message if the formal parameter showReportMessageUpdatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getModificationTime() is not null and _wm.getModificationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 653:"Message last updated:" and the second one the string that the method _wm.getModificationTime() returns HTML encoded

protected void renderParentFolderName (MarkupOutput out, WebMessage _wm)

Will render the parent folder name if the showParentFolderPara formal parameter is true and there is no error in report as stated in the reportInError variable and the WebMessage.getFolderName method returns some string who its lenght is greater than 0 and not null. The method is going to try to see if the folder is using some special description using the FolderNameHelper.getSpecialFolderNameDescription() method if there is no special description then the name will be the string returned by the _wm.getFolderName() method, all this will be rendered inside the 'out' MarkputOutput param as a two span tags one with the descriptor 283:"Parent Folder:" followed by another with the folderName encoded for HTML.

protected void renderPromptDetails (MarkupOutput out, WebMessage _wm)

Method will render on the out variable a table with the descriptor 1309:"Prompt Details" and the result of the PromptsBean transform method using the style stated in the formal parameter reportPromptDetailsStylePara.

Parameters
_wm not used

protected void renderReportDescription (MarkupOutput out, WebMessage _wm)

Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded

protected void renderReportFilter (MarkupOutput out, WebMessage _wm)

Method will render the report filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportFilterPara is true. If reportInError variable is true 1131:"Information not available" will be placed inside the text area, otherwise it will append the tranformation of the filter expression using the ExpressionPlainTextTransform if the filter is not empty or the descriptor 179:"Filter empty" and also shows the template metric limit if it is not null also in the text area.

Parameters
_wm not used

protected void renderReportID (MarkupOutput out, WebMessage _wm)

Method will render the object ID of the WebMessage _wm parameter if the formal parameter showReportIDPara is true, the object id of _wm, if _wm is not null and the object id is not null and its length is greater than zero, or the reportBean objectID is not null and its length greater than zero. This will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 77:"Report ID:" and the second one the _wm.getObjectID() or the ObjectID of the report bean in the case that _vm and _vm.getObjectID() are null or not valid

protected void renderReportLimit (MarkupOutput out, WebMessage _wm)

Method will render the report limit if the formal parameter showReportLimitPara is true, there is no error in the report as stated by the reportInError variable, the template limit retrieved from the reportBean data using the getTemplateLimit() method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 1121:"Report Limit:" and the second one the string that the returned by getTemplateLimit()

Parameters
_wm not used

protected void renderReportName (MarkupOutput out, WebMessage _wm)

Will render a table with the report name as a link when the WebMessage is different of null and the report allows execution, plain text otherwise. The method will get the execution event from the WebMessage using the getExecuteEvent(WebMessage) and render an anchor tag using the generateAnchor(WebEvent) method.

Parameters
out where the output will be rendered
_wm the webMessage used to create the link

protected void renderReportOwner (MarkupOutput out, WebMessage _wm)

Method will render the report owner if the formal parameter showReportOwnerPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectCreator() is not null and _wm.getObjectCreator() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 60:"Owner:" and the second one the string that the method _wm.getObjectCreator() returns HTML encoded

protected void renderReportPath (MarkupOutput out, WebMessage _wm)

Method will render the report path if the formal parameter showReportPathPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 650:"Report path:" and the second one the report path string that the method getReportPath() returns

Parameters
_wm not used at all

protected void renderReportSQL (MarkupOutput out, WebMessage _wm)

Will render the MDX statement if the report is a MDX report or the SQL statement of the report otherwise, will print the descriptor 1097:"The SQL generation is not complete" if the SQL is null or length zero

Parameters
_wm not used

protected void renderReportStatus (MarkupOutput out, WebMessage _wm)

Method will render the report status if the formal parameter showReportStatusPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 187:"Status:" and the second one the string that the method getReportStatus(_wm.getRequestStatus()) returns

protected void renderServerName (MarkupOutput out, WebMessage _wm)

Method will render the number of server name if the formal parameter showServerNamePara is true, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 36:"Server Name:" and the second one the string that the method getServerName of the WebIServerSession class returns HTML encoded

Parameters
_wm not used at all

protected void renderStartTime (MarkupOutput out, WebMessage _wm)

Method will render the modification time of the web message if the formal parameter showReportStartTimePara is true, there is no error in the report as stated by the reportInError variable, _wm.getRequestStartTime() is not null and _wm.getRequestStartTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 188:"Start time:" and the second one the string that the method _wm.getRequestStartTime() returns

protected void renderTemplateDetails (MarkupOutput out, WebMessage _wm)

Will render the template details if the reportInError variable is false and the template details txt area rows and the template details txt area cols, the template details metrics and attributes.

Parameters
_wm not used

protected void renderTemplateName (MarkupOutput out, WebMessage _wm)

Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded

Parameters
_wm not used

protected void renderTotalColumns (MarkupOutput out, WebMessage _wm)

Method will render the number of total columns in the report if the formal parameter showReportTotColsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 649:"Total number of columns:" and the second one the totalColumns that the method getGridTotalColumns of the WebReportData class returns

Parameters
_wm not used at all

protected void renderTotalRows (MarkupOutput out, WebMessage _wm)

Method will render the number of total rows in the report if the formal parameter showReportTotRowsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 648:"Total number of rows:" and the second one the totalRows that the method getGridTotalRows of the WebReportData class returns

Parameters
_wm not used at all

protected void renderViewFilter (MarkupOutput out, WebMessage _wm)

Method will render the view filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportViewFilterPara is true. If reportInError variable is true 1131:"Information not available" will be placed inside the text area, otherwise it will append the tranformation of the filter expression using the ExpressionPlainTextTransform if the filter is not empty or the descriptor 179:"Filter empty" also in the text area.

Parameters
_wm not used