Package com.microstrategy.web.app.transforms

Class DocumentDetailsTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class DocumentDetailsTransform
extends AbstractDocumentTransform
    Deprecated.
    Use DocumentDetailsXHTMLTransform instead.
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • showDocumentName

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

      • showParentFolder

        public FormalParameter showParentFolder
        Deprecated.
        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.

      • showServerName

        public FormalParameter showServerName
        Deprecated.
        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.

      • showDocumentPath

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

      • showDocumentMessage

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

      • showHR1

        public FormalParameter showHR1
        Deprecated.
        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.

      • showHR2

        public FormalParameter showHR2
        Deprecated.
        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.

      • reportDetailsStyle

        public FormalParameter reportDetailsStyle
        Deprecated.
        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.

      • documentPathStyle

        public FormalParameter documentPathStyle
        Deprecated.
        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.

      • isDataSetParameter

        public FormalParameter isDataSetParameter
        Deprecated.
        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.
        Since:
        MicroStrategy Web 7.5.0

      • cssDocumentNameTable

        protected java.lang.String cssDocumentNameTable
        Deprecated.

      • cssDocumentNameProperty

        protected java.lang.String cssDocumentNameProperty
        Deprecated.

      • cssDocumentNameValue

        protected java.lang.String cssDocumentNameValue
        Deprecated.

      • cssDocumentPropertyName

        protected java.lang.String cssDocumentPropertyName
        Deprecated.

      • cssDocumentPropertyValue

        protected java.lang.String cssDocumentPropertyValue
        Deprecated.

      • FP_SHOW_DOCUMENT_NAME

        public static final java.lang.String FP_SHOW_DOCUMENT_NAME
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_PARENT_FOLDER

        public static final java.lang.String FP_SHOW_PARENT_FOLDER
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_SERVER_NAME

        public static final java.lang.String FP_SHOW_SERVER_NAME
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_DOCUMENT_PATH

        public static final java.lang.String FP_SHOW_DOCUMENT_PATH
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_DOCUMENT_MESSAGE

        public static final java.lang.String FP_SHOW_DOCUMENT_MESSAGE
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_HR1

        public static final java.lang.String FP_SHOW_HR1
        Deprecated.
        See Also:
        Constant Field Values

      • FP_SHOW_HR2

        public static final java.lang.String FP_SHOW_HR2
        Deprecated.
        See Also:
        Constant Field Values

      • FP_REPORT_DETAIL_STYLE

        public static final java.lang.String FP_REPORT_DETAIL_STYLE
        Deprecated.
        See Also:
        Constant Field Values

      • FP_DOCUMENT_PATH_STYLE

        public static final java.lang.String FP_DOCUMENT_PATH_STYLE
        Deprecated.
        See Also:
        Constant Field Values

      • FP_IS_DATA_SET_PARAMETER

        public static final java.lang.String FP_IS_DATA_SET_PARAMETER
        Deprecated.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • DocumentDetailsTransform

        public DocumentDetailsTransform()
        Deprecated.
        Default no argument constructor.

    • Method Detail

      • initializeCss

        public void initializeCss()
        Deprecated.
        Initialize the css classes to be used by this transform.
        Overrides:
        initializeCss in class AbstractAppTransform

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Deprecated.
        Overwrites the parent method by setting the iframe property according to the properties of this transform
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent instance to use as base for the link
        Returns:
        AnchorTag instance initialized with the event information
        Since:
        MicroStrategy Web 8.0.0

      • renderName

        public void renderName​(MarkupOutput out)
        Deprecated.
        Renders the name of the document.
        Parameters:
        out - Output by this transform
        Since:
        MicroStrategy Web 8.0.0

      • renderParentName

        public void renderParentName​(MarkupOutput out)
        Deprecated.
        Renders the name of the parent folder of this document.
        Parameters:
        out - Output by this transform
        Since:
        MicroStrategy Web 8.0.0

      • renderServerName

        public void renderServerName​(MarkupOutput out)
        Deprecated.
        Renders the name of the ISERVER name on which this document is run.
        Parameters:
        out - Output by this transform

      • renderPath

        public void renderPath​(MarkupOutput out)
        Deprecated.
        Renders the yahoo path for this document.
        Parameters:
        out - Output by this transform

      • renderMessage

        public void renderMessage​(MarkupOutput out)
        Deprecated.
        Renders the MessageId for this document.
        Parameters:
        out - Output by this transform
        Since:
        MicroStrategy Web 8.0.0

      • renderChildrenDetails

        public void renderChildrenDetails​(MarkupOutput out)
        Deprecated.
        Renders the details for each of the chidlren reports for this document.
        Parameters:
        out - Output by this transform

      • getExecuteEvent

        protected WebEvent getExecuteEvent​(WebDocumentMessage message)
        Deprecated.
        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)

      • canTransform

        public boolean canTransform​(Transformable data)
        Deprecated.
        Overrides canTransform by returning always true. This transform does support showing report details, even if still waiting for prompts.
        Specified by:
        canTransform in interface Transform
        Overrides:
        canTransform in class AbstractDocumentTransform
        Parameters:
        data - the report bean that will transformed.
        Returns:
        true if the data is a ReportBean.
        Since:
        MicroStrategy Web 7.5.3

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Returns the description of this transform.
        This is used in the style catalog editor.
        Returns:
        The description of this transform.

      • renderDataSetOwner

        public void renderDataSetOwner​(MarkupOutput out,
                               WebMessage wm)
        Deprecated.
        Renders the owner information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetStatus

        public void renderDataSetStatus​(MarkupOutput out,
                                WebMessage wm)
        Deprecated.
        Renders the status information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetStartTime

        public void renderDataSetStartTime​(MarkupOutput out,
                                   WebMessage wm)
        Deprecated.
        Renders the start time information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetFinishTime

        public void renderDataSetFinishTime​(MarkupOutput out,
                                    WebMessage wm)
        Deprecated.
        Renders the finish time information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetMessageID

        public void renderDataSetMessageID​(MarkupOutput out,
                                   WebMessage wm)
        Deprecated.
        Renders the message identifier information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetID

        public void renderDataSetID​(MarkupOutput out,
                            WebMessage wm)
        Deprecated.
        Renders the identifier information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetMessageCreated

        public void renderDataSetMessageCreated​(MarkupOutput out,
                                        WebMessage wm)
        Deprecated.
        Renders the message created information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderDataSetMessageUpdated

        public void renderDataSetMessageUpdated​(MarkupOutput out,
                                        WebMessage wm)
        Deprecated.
        Renders the message updated information for the WebMessage of the data set child instance of the RWBean being transformed.
        Parameters:
        wm - WebMessage instance with the information about the data set object being transformed.
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 7.5.4

      • renderReportName

        public void renderReportName​(MarkupOutput out,
                             WebMessage wm)
        Deprecated.
        Since:
        MicroStrategy Web 7.5.4

      • getDatasetStatus

        public java.lang.String getDatasetStatus​(WebMessage message)
        Deprecated.
        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
        Since:
        MicroStrategy Web 7.5.4