public class

DocumentDetailsTransform

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

This class is deprecated.
Use DocumentDetailsXHTMLTransform instead.

Class Overview

This transform is used to show details of a document. It has details like document name, report path and some other things. It also has details about all the constituent reports in the document.

Summary

Constants
String FP_DOCUMENT_PATH_STYLE
String FP_IS_DATA_SET_PARAMETER @deprecated
String FP_REPORT_DETAIL_STYLE
String FP_SHOW_DOCUMENT_MESSAGE
String FP_SHOW_DOCUMENT_NAME
String FP_SHOW_DOCUMENT_PATH
String FP_SHOW_HR1
String FP_SHOW_HR2
String FP_SHOW_PARENT_FOLDER
String FP_SHOW_SERVER_NAME
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String cssDocumentNameProperty
protected String cssDocumentNameTable
protected String cssDocumentNameValue
protected String cssDocumentPropertyName
protected String cssDocumentPropertyValue
public FormalParameter documentPathStyle The name of the style used to show the document path.
public FormalParameter isDataSetParameter The name of the formal parameter on the reportDetailsStyle style to use for displaying the children of the document.
public FormalParameter reportDetailsStyle The name of the style used to show the report details for each of the reports in the document.
public FormalParameter showDocumentMessage This is the flag which we use to decide if we need to show document MessageID on the document details page.
public FormalParameter showDocumentName This is the flag which we use to decide if we need to show the document name on the document details page.
public FormalParameter showDocumentPath This is the flag which we use to decide if we need to show the document path (yahoo path) on the document details page.
public FormalParameter showHR1 This is the flag which we use to decide if we need to show a horizontal line before the document MessageID on the document details page.
public FormalParameter showHR2 This is the flag which we use to decide if we need to show a horizontal line after the document MessageID on the document details page.
public FormalParameter showParentFolder This is the flag which we use to decide if we need to show the name of the document parent folder on the document details page.
public FormalParameter showServerName This is the flag which we use to decide if we need to show the name of the Intelligent Server on the document details page.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DocumentDetailsTransform()
Default no argument constructor.
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform by returning always true.
String getDatasetStatus(WebMessage message)
Render the status of the message.
String getDescription()
Returns the description of this transform.
Class getSupportedBeanType()
Returns the supported bean type for the transform.
void initializeCss()
Initialize the css classes to be used by this transform.
void renderChildrenDetails(MarkupOutput out)
Renders the details for each of the chidlren reports for this 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 renderDataSetOwner(MarkupOutput out, WebMessage wm)
Renders the owner information for the WebMessage of the data set child instance of the RWBean being transformed.
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 renderMessage(MarkupOutput out)
Renders the MessageId for this document.
void renderName(MarkupOutput out)
Renders the name of the document.
void renderParentName(MarkupOutput out)
Renders the name of the parent folder of this document.
void renderPath(MarkupOutput out)
Renders the yahoo path for this document.
void renderReportName(MarkupOutput out, WebMessage wm)
void renderServerName(MarkupOutput out)
Renders the name of the ISERVER name on which this document is run.
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
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting the iframe property according to the properties of this transform
WebEvent getExecuteEvent(WebDocumentMessage message)
Returns an event to run the document.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
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

Constants

public static final String FP_DOCUMENT_PATH_STYLE

Constant Value: "documentPathStyle"

public static final String FP_IS_DATA_SET_PARAMETER

@deprecated

Constant Value: "isDataSetParameter"

public static final String FP_REPORT_DETAIL_STYLE

Constant Value: "reportDetailsStyle"

public static final String FP_SHOW_DOCUMENT_MESSAGE

Constant Value: "showDocumentMessage"

public static final String FP_SHOW_DOCUMENT_NAME

Constant Value: "showDocumentName"

public static final String FP_SHOW_DOCUMENT_PATH

Constant Value: "showDocumentPath"

public static final String FP_SHOW_HR1

Constant Value: "showHR1"

public static final String FP_SHOW_HR2

Constant Value: "showHR2"

public static final String FP_SHOW_PARENT_FOLDER

Constant Value: "showParentFolder"

public static final String FP_SHOW_SERVER_NAME

Constant Value: "showServerName"

Fields

protected String cssDocumentNameProperty

protected String cssDocumentNameTable

protected String cssDocumentNameValue

protected String cssDocumentPropertyName

protected String cssDocumentPropertyValue

public FormalParameter documentPathStyle

The name of the style used to show the document path.
This style has to be present in the style catalog. This formal parameter has no significance if the formal parameter used to show the document path is set to false.

public FormalParameter isDataSetParameter

The name of the formal parameter on the reportDetailsStyle style to use for displaying the children of the document.
This formal parameter is used for indicating the reportDetailsStyle style that the object which information is to be rendered is a data set object, not a report bean. The formal parameter name specified here should correspond to a boolean formal parameter.@deprecated

public FormalParameter reportDetailsStyle

The name of the style used to show the report details for each of the reports in the document.
This style has to be present in the style catalog and it must be able to transform a report bean. It also has to match one of the styles specified in the page config file for this page.

public FormalParameter showDocumentMessage

This is the flag which we use to decide if we need to show document MessageID on the document details page.

public FormalParameter showDocumentName

This is the flag which we use to decide if we need to show the document name on the document details page.

public FormalParameter showDocumentPath

This is the flag which we use to decide if we need to show the document path (yahoo path) on the document details page.

public FormalParameter showHR1

This is the flag which we use to decide if we need to show a horizontal line before the document MessageID on the document details page.

public FormalParameter showHR2

This is the flag which we use to decide if we need to show a horizontal line after the document MessageID on the document details page.

public FormalParameter showParentFolder

This is the flag which we use to decide if we need to show the name of the document parent folder on the document details page.

public FormalParameter showServerName

This is the flag which we use to decide if we need to show the name of the Intelligent Server on the document details page.

Public Constructors

public DocumentDetailsTransform ()

Default no argument 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 getDatasetStatus (WebMessage message)

Render the status of the message. If status is "Read" then it also renders a link to mark as unread.

Parameters
message WebMessage instance being rendered

public String getDescription ()

Returns the description of this transform.
This is used in the style catalog editor.

Returns
  • The description of this transform.

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

public void initializeCss ()

Initialize the css classes to be used by this transform.

public void renderChildrenDetails (MarkupOutput out)

Renders the details for each of the chidlren reports for this document.

Parameters
out Output by this transform

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 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 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 renderMessage (MarkupOutput out)

Renders the MessageId for this document.

Parameters
out Output by this transform

public void renderName (MarkupOutput out)

Renders the name of the document.

Parameters
out Output by this transform

public void renderParentName (MarkupOutput out)

Renders the name of the parent folder of this document.

Parameters
out Output by this transform

public void renderPath (MarkupOutput out)

Renders the yahoo path for this document.

Parameters
out Output by this transform

public void renderReportName (MarkupOutput out, WebMessage wm)

public void renderServerName (MarkupOutput out)

Renders the name of the ISERVER name on which this document is run.

Parameters
out Output 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 AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting the iframe property according to the properties of this transform

Parameters
event WebEvent instance to use as base for the link
Returns
  • AnchorTag instance initialized with the event information

protected WebEvent getExecuteEvent (WebDocumentMessage message)

Returns an event to run the document.

Parameters
message The (@link WebDocumentMessage} for this document.
Returns
  • A WebEvent to execute the message (i.e., runDocuments)