public class

RWDetailsTransform

extends AbstractRWTransform
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.AbstractRWTransform
             ↳ com.microstrategy.web.app.transforms.RWDetailsTransform

Class Overview

This transform is used to show details of a report writing document. It has details like name, path and some other things. It also has details about all the children data set objects in it.

Summary

Constants
int DATASET_LEVEL_ALL This constant is deprecated. please use the layout xml
int DATASET_LEVEL_CREATED_INFO This constant is deprecated. please use the layout xml
int DATASET_LEVEL_FINISH_TIME This constant is deprecated. please use the layout xml
int DATASET_LEVEL_LAST_UPDATE_INFO This constant is deprecated. please use the layout xml
int DATASET_LEVEL_MESSAGE_ID This constant is deprecated. please use the layout xml
int DATASET_LEVEL_OWNER This constant is deprecated. please use the layout xml
int DATASET_LEVEL_REPORT_ID This constant is deprecated. please use the layout xml
int DATASET_LEVEL_SERVER_NAME This constant is deprecated. please use the layout xml
int DATASET_LEVEL_START_TIME This constant is deprecated. please use the layout xml
int DATASET_LEVEL_STATUS This constant is deprecated. please use the layout xml
String FP_DATASET_DISPLAY_LEVEL Constant specifying the name of the formal parameter for defining the display level flag for the data sets.
String FP_DOCUMENT_DISPLAY_LEVEL Constant specifying the name of the formal parameter for defining the display level flag for the report writing document.
String FP_DOCUMENT_PATH_STYLE Constant specifying the name of the formal parameter for defining the style to use for displaying the report writing document path.
int LEVEL_ALL This constant is deprecated. use layout instead.
int LEVEL_DATASET_INFO This constant is deprecated. please use the layout xml
int LEVEL_DESCRIPTION This constant is deprecated. please use the layout xml
int LEVEL_DOCUMENT_ID This constant is deprecated. please use the layout xml
int LEVEL_MESSAGE_ID This constant is deprecated. please use the layout xml
int LEVEL_NAME This constant is deprecated. please use the layout xml
int LEVEL_OWNER This constant is deprecated. please use the layout xml
int LEVEL_PATH This constant is deprecated. please use the layout xml
int LEVEL_SERVER_NAME This constant is deprecated. please use the layout xml
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter datasetDisplayLevelFlag This field is deprecated. please use the layout xml
public FormalParameter documentDisplayLevelFlag This field is deprecated. please use the layout xml
public FormalParameter documentPathStyle This field is deprecated. please use the layout xml
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWDetailsTransform()
Default no-argument constructor.
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform by returning always true.
boolean checkLevel(int level)
Check if the level parameter value contains this flag.
String getAdvancedDivId(RWDataSetDetails details)
Generate the id of the div which holds advaned detail information for the RWDataSetDetails instance of an individual dataset.
String getAdvancedDivId()
Generate the id of the div which holds advaned detail information for the document.
String getAncestorName(WebFolder folder)
Get the name of an ancestor folder.
SimpleList getAncestors(RWDetails details)
Retrieves the ancestors of the RWDetails instance.
WebMessages getChildrenMessages()
This method is deprecated. not used any more
String getCssClassName(String cssName)
Generate the css class name used by this transform.
List getDatasets()
Returns all the datasets based on the RWDocumentDetails instance of the RWBean being transformed.
String getDescription()
Returns the textual description of the transform
String getDocumentID()
Get the document identifier based on the RWDocumentDetails instance of the RWBean being transformed.
String getDocumentStatus()
Get the document status based on the RWDocumentDetails instance of the RWBean being transformed.
String getFinishTime()
Get the message finish time based on the RWDocumentDetails instance of the RWBean being transformed.
String getFinishTime(RWDataSetDetails details)
Get the message finish time based on the RWDataSetDetails instance of an individual dataset.
String getJobID(RWDataSetDetails details)
Get the job identifier based on the RWDataSetDetails instance of an individual dataset.
String getJobID()
Get the job identifier based on the RWDocumentDetails instance of the RWBean being transformed.
String getMessageCreationTime()
Get the message creation time based on the RWDocumentDetails instance of the RWBean being transformed.
String getMessageCreationTime(RWDataSetDetails details)
Get the message creation time based on the RWDataSetDetails instance of an individual dataset.
String getMessageID(RWDataSetDetails details)
Get the message identifier based on the RWDataSetDetails instance of an individual dataset.
String getMessageID()
Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.
String getMessageModificationTime(RWDataSetDetails details)
Get the message modification time based on the RWDataSetDetails instance of an individual dataset.
String getMessageModificationTime()
Get the message modification time based on the RWDocumentDetails instance of the RWBean being transformed.
String getMessageName()
Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.
String getModifiedInformation()
Get the modification time based on the RWDocumentDetails instance of the RWBean being transformed.
String getModifiedInformation(RWDataSetDetails details)
Get the modification time based on the RWDataSetDetails instance of an individual dataset.
String getObjectName()
List getObjectPathFolderAncestors(int rootIndex)
Returns all the ancestors of the document
List getObjectPathFolderAncestors(int rootIndex, RWDetails details)
Returns all the ancestors of the RWDetails instance
String getOwner()
Get the owner based on the RWDocumentDetails instance of the RWBean being transformed.
String getProjectName()
Get the project name based on the PathBean of the RWBean being transformed.
String getRWDescription()
Get the document description based on the RWDocumentDetails instance of the RWBean being transformed.
String getReportDescription(RWDataSetDetails datasetDetails)
Get the report(dataset) description based on the RWDataSetDetails instance of an individual dataset.
String getReportDetails(RWDataSetDetails details)
Get report details from the RWDataSetDetails of an individual dataset.
String getReportID(RWDataSetDetails details)
Get the report identifier based on the RWDataSetDetails instance of an individual dataset.
String getReportName(RWDataSetDetails datasetDetails)
Get the report name based on the RWDataSetDetails instance of an individual dataset.
String getReportOwner(RWDataSetDetails datasetDetails)
Get the owner based on the RWDataSetDetails instance of an individual dataset.
String getReportSQL(RWDataSetDetails details)
Get report SQL from the RWDataSetDetails of an individual dataset.
String getReportStatus(RWDataSetDetails details)
Get the report(dataset) status on the RWDataSetDetails instance of an individual dataset.
String getReportType(RWDataSetDetails details)
Get the report type based on the RWDataSetDetails instance of an individual dataset.
String getServerName(RWDataSetDetails details)
Get the server name based on the RWDataSetDetails instance of an individual dataset.
String getServerName()
Get the server name based on the RWDocumentDetails instance of the RWBean being transformed.
String getStartTime()
Get the message start time based on the RWDocumentDetails instance of the RWBean being transformed.
String getStartTime(RWDataSetDetails details)
Get the message start time based on the RWDataSetDetails instance of an individual dataset.
int getTotalColumns(RWDataSetDetails details)
Get the total number of columns returned based on the RWDataSetDetails instance of an individual dataset.
int getTotalRows(RWDataSetDetails details)
Get the total number of rows returned based on the RWDataSetDetails instance of an individual dataset.
WebEvent getWebReexecuteEvent()
Returns the reexecute event Always get the event from the servlet.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isAdvancedAreaExpanded()
Determines based on the formal parameter if the advanced detail information are is requested to be expanded or not
boolean isAdvancedAreaVisible()
This method is deprecated. use layout instead.
void renderAdvancedAreaJavaScript(MarkupOutput out)
Renders JavaScript (if any) that will be related with the advanced information area for the document.
void renderAdvancedDetailsButton(MarkupOutput out, RWDataSetDetails details)
Renders the button to toggle advanced detail area for an individual dataset
void renderAdvancedDetailsButton(MarkupOutput out, boolean requestExpand, RWDataSetDetails details)
Render the button that will allow users to show or not the advanced details information about the individual dataset.
void renderAdvancedDetailsButton(MarkupOutput out)
Renders the button to toggle advanced detail area for document.
void renderDataSetFinishTime(MarkupOutput out, WebMessage wm)
Renders the finish time information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetID(MarkupOutput out, WebMessage wm)
Renders the identifier information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetMessageCreated(MarkupOutput out, WebMessage wm)
Renders the message created information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetMessageID(MarkupOutput out, WebMessage wm)
Renders the message identifier information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetMessageUpdated(MarkupOutput out, WebMessage wm)
Renders the message updated information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetName(MarkupOutput out, WebMessage wm)
Renders the name information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetOwner(MarkupOutput out, WebMessage wm)
Renders the owner information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetServerName(MarkupOutput out, WebMessage wm)
This method is deprecated. not used anymore
void renderDataSetStartTime(MarkupOutput out, WebMessage wm)
Renders the start time information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDataSetStatus(MarkupOutput out, WebMessage wm)
Renders the status information for the WebMessage of the data set child instance of the RWBean being transformed.
void renderDescription(MarkupOutput out)
Renders the description information for RWDocumentDetails instance of the RWBean being transformed.
void renderDocumentID(MarkupOutput out)
Renders the document ID information for the RWDocumentDetails instance of the RWBean being transformed.
void renderMessage(MarkupOutput out)
Renders the message identifier information for the RWBean being transformed.
void renderName(MarkupOutput out)
Generate the HTML with the report writing document title information.
void renderOwner(MarkupOutput out)
Renders the owner information for RWDocumentDetails instance of the RWBean being transformed.
void renderPath(MarkupOutput out)
Renders the path information for the the RWDocumentDetails instance of the RWBean being transformed.
void renderServerName(MarkupOutput out)
Renders the server name information for the RWDocumentDetails instance of the RWBean being transformed.
void renderToggleAdvancedArea(MarkupOutput out, RWDataSetDetails details)
Render the toogleAdvancedArea javascript code based on the RWDataSetDetails instance of an individual dataset.
boolean shouldRenderAdvancedAreaExpanded()
Check to see if advanced area should be rendered.
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
String getDatasetStatus(int status)
Based on the status code of the object, obtain the descriptor to be shown to the user
WebEvent getExecuteDocumentEvent(RWMessage rwm)
Obtain the event to be used for executing the report writing document.
WebEvent getExecuteDocumentEvent(RWDetails details)
Obtain the event to be used for executing the report writing document.
RWDocumentDetails getRWDetails()
RWMessage getRWDocumentMessage()
TransformInstance getRWDocumentPathTransform(RWBean rw)
This method is deprecated. not used anymore
WebEvent getShowDetailsEvent()
Generate the WebEvent instance to be used for showing the details of the document (to refresh the page information).
void initializeRWDetails()
Initialize the RWDetails instance out of the RWBean being transformed.
void initializeRWDocumentMessage()
Obtains the RWMessage instance out of the RWBean being transformed, for initializing the property of this transform.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractRWTransform
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 DATASET_LEVEL_ALL

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Convenience flag to indicate all possible DATASET_DISPLAY_LEVEL values.
Value = 16777215

Constant Value: -1 (0xffffffff)

public static final int DATASET_LEVEL_CREATED_INFO

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's create time.
Value = 8

Constant Value: 8 (0x00000008)

public static final int DATASET_LEVEL_FINISH_TIME

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's execution finish time.
Value = 64

Constant Value: 64 (0x00000040)

public static final int DATASET_LEVEL_LAST_UPDATE_INFO

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's last update time.
Value = 16

Constant Value: 16 (0x00000010)

public static final int DATASET_LEVEL_MESSAGE_ID

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's message id.
Value = 1

Constant Value: 1 (0x00000001)

public static final int DATASET_LEVEL_OWNER

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's owner.
Value = 128

Constant Value: 128 (0x00000080)

public static final int DATASET_LEVEL_REPORT_ID

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's report id.
Value = 2

Constant Value: 2 (0x00000002)

public static final int DATASET_LEVEL_SERVER_NAME

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's server name.
Value = 512

Constant Value: 512 (0x00000200)

public static final int DATASET_LEVEL_START_TIME

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's execution start time.
Value = 32

Constant Value: 32 (0x00000020)

public static final int DATASET_LEVEL_STATUS

This constant is deprecated.
please use the layout xml

Allowed value for the datasetDisplayLevelFlag formal parameter. Specifies that the transform will display information about the data set's current status.
Value = 4

Constant Value: 4 (0x00000004)

public static final String FP_DATASET_DISPLAY_LEVEL

Constant specifying the name of the formal parameter for defining the display level flag for the data sets. Value is datasetDisplayLevelFlag.

Constant Value: "datasetDisplayLevelFlag"

public static final String FP_DOCUMENT_DISPLAY_LEVEL

Constant specifying the name of the formal parameter for defining the display level flag for the report writing document. Value is documentDisplayLevelFlag.

Constant Value: "documentDisplayLevelFlag"

public static final String FP_DOCUMENT_PATH_STYLE

Constant specifying the name of the formal parameter for defining the style to use for displaying the report writing document path. Value is documentPathStyle.

Constant Value: "documentPathStyle"

public static final int LEVEL_ALL

This constant is deprecated.
use layout instead.

Allowed value for the documentDisplayLevelFlag formal parameter. Convenience flag to indicate all possible DOCUMENT_DISPLAY_LEVEL values.
Value = 16777215

Constant Value: -1 (0xffffffff)

public static final int LEVEL_DATASET_INFO

This constant is deprecated.
please use the layout xml

Allowed value for the documentDisplayLevelFlag formal parameter. Specifies that the report writing document transform will display information about the children data sets.
Value = 16

Constant Value: 16 (0x00000010)

public static final int LEVEL_DESCRIPTION

This constant is deprecated.
please use the layout xml

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_DOCUMENT_ID

This constant is deprecated.
please use the layout xml

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

Constant Value: 256 (0x00000100)

public static final int LEVEL_MESSAGE_ID

This constant is deprecated.
please use the layout xml

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

Constant Value: 128 (0x00000080)

public static final int LEVEL_NAME

This constant is deprecated.
please use the layout xml

Allowed value for the documentDisplayLevelFlag formal parameter. Specifies that the report writing document transform will display a title including the object's name.
Value = 1

Constant Value: 1 (0x00000001)

public static final int LEVEL_OWNER

This constant is deprecated.
please use the layout xml

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

Constant Value: 8 (0x00000008)

public static final int LEVEL_PATH

This constant is deprecated.
please use the layout xml

Allowed value for the documentDisplayLevelFlag formal parameter. Specifies that the report writing document transform will display the folder path where the object is located.
Value = 32

Constant Value: 32 (0x00000020)

public static final int LEVEL_SERVER_NAME

This constant is deprecated.
please use the layout xml

Allowed value for the documentDisplayLevelFlag formal parameter. Specifies that the report writing document transform will display the name of the server where the object is located.
Value = 4

Constant Value: 4 (0x00000004)

Fields

public FormalParameter datasetDisplayLevelFlag

This field is deprecated.
please use the layout xml

Indicates the level of information to use when displaying a data set item.
The information may include title with message id, report id 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 DATASET_LEVEL_MESSAGE_ID, DATASET_LEVEL_REPORT_ID, DATASET_LEVEL_STATUS, etc. For a complete list, refer to RWDetailsTransform.
Usage: If message id, report id and current status should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is DATASET_LEVEL_ALL

public FormalParameter documentDisplayLevelFlag

This field is deprecated.
please use the layout xml

Indicates the level of information to use when displaying the report writing document item.
The information may include title with object name, location 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_PATH, LEVEL_SERVER_NAME, etc. For a complete list, refer to RWDetailsTransform.
Usage: If title and server name should be displayed, the value to assign to the formal parameter would be 5 (1 + 4). Default value is LEVEL_ALL

public FormalParameter documentPathStyle

This field is deprecated.
please use the layout xml

The name of the style used to show the report writing document path.
This formal parameter has no significance if the formal parameter indicating display level does not include to show the document path.

Public Constructors

public RWDetailsTransform ()

Default no-argument constructor. Initializes formal parameters.

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 bean that will transformed.
Returns
  • true if the data is a RWBean.

public boolean checkLevel (int level)

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

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

public String getAdvancedDivId (RWDataSetDetails details)

Generate the id of the div which holds advaned detail information for the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the generated id

public String getAdvancedDivId ()

Generate the id of the div which holds advaned detail information for the document.

Returns
  • the generated id

public String getAncestorName (WebFolder folder)

Get the name of an ancestor folder.

Parameters
folder the ancestor folder
Returns
  • the name of the folder

public SimpleList getAncestors (RWDetails details)

Retrieves the ancestors of the RWDetails instance.

Parameters
details the RWDetails instance we need to retrieve ancestors from
Returns
  • the ancestors list

public WebMessages getChildrenMessages ()

This method is deprecated.
not used any more

Obtain the WebMessage children instances that are defined for the current RWMessage of the RWBean being transformed

Returns
  • WebMessages initialized instance with the information of the child data set messages defined.

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 List getDatasets ()

Returns all the datasets based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • a list of datasets

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public String getDocumentID ()

Get the document identifier based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the document identifier

public String getDocumentStatus ()

Get the document status based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the document status

public String getFinishTime ()

Get the message finish time based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the message finish time

public String getFinishTime (RWDataSetDetails details)

Get the message finish time based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the message finish time

public String getJobID (RWDataSetDetails details)

Get the job identifier based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the job identifer

public String getJobID ()

Get the job identifier based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the job identifier

public String getMessageCreationTime ()

Get the message creation time based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the message creation time

public String getMessageCreationTime (RWDataSetDetails details)

Get the message creation time based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the message creation time

public String getMessageID (RWDataSetDetails details)

Get the message identifier based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the message identifier

public String getMessageID ()

Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the document name

public String getMessageModificationTime (RWDataSetDetails details)

Get the message modification time based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the message modification time

public String getMessageModificationTime ()

Get the message modification time based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the message modification time

public String getMessageName ()

Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the document name

public String getModifiedInformation ()

Get the modification time based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the modification time

public String getModifiedInformation (RWDataSetDetails details)

Get the modification time based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the modification time

public String getObjectName ()

public List getObjectPathFolderAncestors (int rootIndex)

Returns all the ancestors of the document

Parameters
rootIndex , indicates the starting index of the ancestor
Returns
  • a list of ancestors, the order is top down, the first ancestor (index 0) is the the highest ancestor (i.e, server, project)

public List getObjectPathFolderAncestors (int rootIndex, RWDetails details)

Returns all the ancestors of the RWDetails instance

Parameters
rootIndex , indicates the starting index of the ancestor
details the RWDetails instance we need to retrieve ancestors from
Returns
  • a list of ancestors, the order is top down, the first ancestor (index 0) is the the highest ancestor (i.e, server, project)

public String getOwner ()

Get the owner based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the owner

public String getProjectName ()

Get the project name based on the PathBean of the RWBean being transformed.

Returns
  • the project name

public String getRWDescription ()

Get the document description based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the document description

public String getReportDescription (RWDataSetDetails datasetDetails)

Get the report(dataset) description based on the RWDataSetDetails instance of an individual dataset.

Parameters
datasetDetails the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report(dataset) description

public String getReportDetails (RWDataSetDetails details)

Get report details from the RWDataSetDetails of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report detail string

public String getReportID (RWDataSetDetails details)

Get the report identifier based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report identifier

public String getReportName (RWDataSetDetails datasetDetails)

Get the report name based on the RWDataSetDetails instance of an individual dataset.

Parameters
datasetDetails the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report(dataset) name

public String getReportOwner (RWDataSetDetails datasetDetails)

Get the owner based on the RWDataSetDetails instance of an individual dataset.

Parameters
datasetDetails the RWDataSetDetails instance associated with the individual dataset
Returns
  • the owner

public String getReportSQL (RWDataSetDetails details)

Get report SQL from the RWDataSetDetails of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report SQL string

public String getReportStatus (RWDataSetDetails details)

Get the report(dataset) status on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report(dataset) status

public String getReportType (RWDataSetDetails details)

Get the report type based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the report type

public String getServerName (RWDataSetDetails details)

Get the server name based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the server name for the inidividual dataset.

public String getServerName ()

Get the server name based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the server name

public String getStartTime ()

Get the message start time based on the RWDocumentDetails instance of the RWBean being transformed.

Returns
  • the message start time

public String getStartTime (RWDataSetDetails details)

Get the message start time based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the message start time

public int getTotalColumns (RWDataSetDetails details)

Get the total number of columns returned based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the total number of columns retrieved

public int getTotalRows (RWDataSetDetails details)

Get the total number of rows returned based on the RWDataSetDetails instance of an individual dataset.

Parameters
details the RWDataSetDetails instance associated with the individual dataset
Returns
  • the total number of rows retrieved

public WebEvent getWebReexecuteEvent ()

Returns the reexecute event Always get the event from the servlet.

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 isAdvancedAreaExpanded ()

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

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

public boolean isAdvancedAreaVisible ()

This method is deprecated.
use layout instead.

Indicates if the Document 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: server name, message identifier, document identifier, message created, message updated and/or level status.

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

public void renderAdvancedAreaJavaScript (MarkupOutput out)

Renders JavaScript (if any) that will be related with the advanced information area for the document. 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, RWDataSetDetails details)

Renders the button to toggle advanced detail area for an individual dataset

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
details the RWDataSetDetails instance associated with the individual dataset

public void renderAdvancedDetailsButton (MarkupOutput out, boolean requestExpand, RWDataSetDetails details)

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

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
details the RWDataSetDetails instance associated with the individual dataset

public void renderAdvancedDetailsButton (MarkupOutput out)

Renders the button to toggle advanced detail area for document.

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

public void renderDataSetFinishTime (MarkupOutput out, WebMessage wm)

Renders the finish time information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetID (MarkupOutput out, WebMessage wm)

Renders the identifier information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetMessageCreated (MarkupOutput out, WebMessage wm)

Renders the message created information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetMessageID (MarkupOutput out, WebMessage wm)

Renders the message identifier information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetMessageUpdated (MarkupOutput out, WebMessage wm)

Renders the message updated information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetName (MarkupOutput out, WebMessage wm)

Renders the name information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetOwner (MarkupOutput out, WebMessage wm)

Renders the owner information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetServerName (MarkupOutput out, WebMessage wm)

This method is deprecated.
not used anymore

Renders the server name information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetStartTime (MarkupOutput out, WebMessage wm)

Renders the start time information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDataSetStatus (MarkupOutput out, WebMessage wm)

Renders the status information for the WebMessage of the data set child instance of the RWBean being transformed.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
wm WebMessage instance with the information about the data set object being transformed.

public void renderDescription (MarkupOutput out)

Renders the description information for RWDocumentDetails instance of the RWBean being transformed.

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

public void renderDocumentID (MarkupOutput out)

Renders the document ID information for the RWDocumentDetails instance of the RWBean being transformed.

Parameters
out MarkupOutput

public void renderMessage (MarkupOutput out)

Renders the message identifier information for the RWBean being transformed.

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

public void renderName (MarkupOutput out)

Generate the HTML with the report writing document title information.

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

public void renderOwner (MarkupOutput out)

Renders the owner information for RWDocumentDetails instance of the RWBean being transformed.

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

public void renderPath (MarkupOutput out)

Renders the path information for the the RWDocumentDetails instance of the RWBean being transformed.

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

public void renderServerName (MarkupOutput out)

Renders the server name information for the RWDocumentDetails instance of the RWBean being transformed.

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

public void renderToggleAdvancedArea (MarkupOutput out, RWDataSetDetails details)

Render the toogleAdvancedArea javascript code based on the RWDataSetDetails instance of an individual dataset.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
details the RWDataSetDetails instance associated with the individual dataset

public boolean shouldRenderAdvancedAreaExpanded ()

Check to see if advanced area should be rendered.

Returns
  • true 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 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 "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 successfull transform;

Parameters
out Output by this transform

Protected Methods

protected String getDatasetStatus (int status)

Based on the status code of the object, obtain the descriptor to be shown to the user

Parameters
status the status variable
Returns
  • a string with a descriptor to display to the user based on the status code

protected WebEvent getExecuteDocumentEvent (RWMessage rwm)

Obtain the event to be used for executing the report writing document.

Parameters
rwm the (@link RWMessage} for the RWBean beings displayed.
Returns
  • a WebEvent instance to execute the report writing document message. By default it returns the REPORT_WRITER_EVENT_EXECUTE event, or null if it is not supported by the application

protected WebEvent getExecuteDocumentEvent (RWDetails details)

Obtain the event to be used for executing the report writing document.

Parameters
details the (@link RWDetails} for the RWBean beings displayed.
Returns
  • a WebEvent instance to execute the report writing document message. By default it returns the REPORT_WRITER_EVENT_EXECUTE event, or null if it is not supported by the application

protected RWDocumentDetails getRWDetails ()

protected RWMessage getRWDocumentMessage ()

Returns

protected TransformInstance getRWDocumentPathTransform (RWBean rw)

This method is deprecated.
not used anymore

protected WebEvent getShowDetailsEvent ()

Generate the WebEvent instance to be used for showing the details of the document (to refresh the page information). the WebEventGetDocumentDetails event, or null if it is not supported by the application

protected void initializeRWDetails ()

Initialize the RWDetails instance out of the RWBean being transformed.

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

protected void initializeRWDocumentMessage ()

Obtains the RWMessage instance out of the RWBean 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