Package com.microstrategy.web.app.transforms

Class RWDetailsTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class RWDetailsTransform
extends AbstractRWTransform
implements LayoutTransform
    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.
    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • LEVEL_NAME

        @Deprecated
public static final int LEVEL_NAME
        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
        See Also:
        Constant Field Values

      • LEVEL_DESCRIPTION

        @Deprecated
public static final int LEVEL_DESCRIPTION
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's description.
        Value = 2
        See Also:
        Constant Field Values

      • LEVEL_SERVER_NAME

        @Deprecated
public static final int LEVEL_SERVER_NAME
        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
        See Also:
        Constant Field Values

      • LEVEL_OWNER

        @Deprecated
public static final int LEVEL_OWNER
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's owner.
        Value = 8
        See Also:
        Constant Field Values

      • LEVEL_DATASET_INFO

        @Deprecated
public static final int LEVEL_DATASET_INFO
        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
        See Also:
        Constant Field Values

      • LEVEL_PATH

        @Deprecated
public static final int LEVEL_PATH
        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
        See Also:
        Constant Field Values

      • LEVEL_MESSAGE_ID

        @Deprecated
public static final int LEVEL_MESSAGE_ID
        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
        See Also:
        Constant Field Values

      • LEVEL_DOCUMENT_ID

        @Deprecated
public static final int LEVEL_DOCUMENT_ID
        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
        See Also:
        Constant Field Values

      • LEVEL_ALL

        @Deprecated
public static final int LEVEL_ALL
        Deprecated.
        use layout instead.
        Allowed value for the documentDisplayLevelFlag formal parameter. Convenience flag to indicate all possible DOCUMENT_DISPLAY_LEVEL values.
        Value = 16777215
        See Also:
        Constant Field Values

      • DATASET_LEVEL_MESSAGE_ID

        @Deprecated
public static final int DATASET_LEVEL_MESSAGE_ID
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_REPORT_ID

        @Deprecated
public static final int DATASET_LEVEL_REPORT_ID
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_STATUS

        @Deprecated
public static final int DATASET_LEVEL_STATUS
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_CREATED_INFO

        @Deprecated
public static final int DATASET_LEVEL_CREATED_INFO
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_LAST_UPDATE_INFO

        @Deprecated
public static final int DATASET_LEVEL_LAST_UPDATE_INFO
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_START_TIME

        @Deprecated
public static final int DATASET_LEVEL_START_TIME
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_FINISH_TIME

        @Deprecated
public static final int DATASET_LEVEL_FINISH_TIME
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_OWNER

        @Deprecated
public static final int DATASET_LEVEL_OWNER
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_SERVER_NAME

        @Deprecated
public static final int DATASET_LEVEL_SERVER_NAME
        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
        See Also:
        Constant Field Values

      • DATASET_LEVEL_ALL

        @Deprecated
public static final int DATASET_LEVEL_ALL
        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
        See Also:
        Constant Field Values

      • documentDisplayLevelFlag

        @Deprecated
public FormalParameter documentDisplayLevelFlag
        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

      • datasetDisplayLevelFlag

        @Deprecated
public FormalParameter datasetDisplayLevelFlag
        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

      • documentPathStyle

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

      • FP_DOCUMENT_DISPLAY_LEVEL

        public static final java.lang.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.
        See Also:
        Constant Field Values

      • FP_DATASET_DISPLAY_LEVEL

        public static final java.lang.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.
        See Also:
        Constant Field Values

      • FP_DOCUMENT_PATH_STYLE

        public static final java.lang.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.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RWDetailsTransform

        public RWDetailsTransform()
        Default no-argument constructor. Initializes formal parameters.

    • Method Detail

      • renderName

        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.

      • renderToggleAdvancedArea

        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
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedDetailsButton

        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.
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedDetailsButton

        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
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedAreaJavaScript

        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.
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedDetailsButton

        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
        Since:
        MicroStrategy Web 9.0.0

      • getMessageName

        public java.lang.String getMessageName()
        Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the document name
        Since:
        MicroStrategy Web 9.0.0

      • getObjectName

        public java.lang.String getObjectName()
        Since:
        MicroStrategy Web 9.0.0

      • getMessageID

        public java.lang.String getMessageID()
        Get the document name based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the document name
        Since:
        MicroStrategy Web 9.0.0

      • getMessageCreationTime

        public java.lang.String getMessageCreationTime()
        Get the message creation time based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the message creation time
        Since:
        MicroStrategy Web 9.0.0

      • getMessageModificationTime

        public java.lang.String getMessageModificationTime()
        Get the message modification time based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the message modification time
        Since:
        MicroStrategy Web 9.0.0

      • getJobID

        public java.lang.String getJobID()
        Get the job identifier based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the job identifier
        Since:
        MicroStrategy Web 9.0.0

      • getOwner

        public java.lang.String getOwner()
        Get the owner based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the owner
        Since:
        MicroStrategy Web 9.0.0

      • getRWDescription

        public java.lang.String getRWDescription()
        Get the document description based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the document description
        Since:
        MicroStrategy Web 9.0.0

      • getModifiedInformation

        public java.lang.String getModifiedInformation()
        Get the modification time based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the modification time
        Since:
        MicroStrategy Web 9.0.0

      • getDocumentStatus

        public java.lang.String getDocumentStatus()
        Get the document status based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the document status
        Since:
        MicroStrategy Web 9.0.0

      • getStartTime

        public java.lang.String getStartTime()
        Get the message start time based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the message start time
        Since:
        MicroStrategy Web 9.0.0

      • getFinishTime

        public java.lang.String getFinishTime()
        Get the message finish time based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the message finish time
        Since:
        MicroStrategy Web 9.0.0

      • getDocumentID

        public java.lang.String getDocumentID()
        Get the document identifier based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the document identifier
        Since:
        MicroStrategy Web 9.0.0

      • getProjectName

        public java.lang.String getProjectName()
        Get the project name based on the PathBean of the RWBean being transformed.
        Returns:
        the project name
        Since:
        MicroStrategy Web 9.0.0

      • getObjectPathFolderAncestors

        public java.util.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)
        Since:
        MicroStrategy Web 9.0.0

      • getServerName

        public java.lang.String getServerName()
        Get the server name based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        the server name

      • getAdvancedDivId

        public java.lang.String getAdvancedDivId()
        Generate the id of the div which holds advaned detail information for the document.
        Returns:
        the generated id
        Since:
        MicroStrategy Web 9.0.0

      • getDatasets

        public java.util.List getDatasets()
        Returns all the datasets based on the RWDocumentDetails instance of the RWBean being transformed.
        Returns:
        a list of datasets
        Since:
        MicroStrategy Web 9.0.0

      • getAncestors

        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
        Since:
        MicroStrategy Web 9.0.0

      • getAncestorName

        public java.lang.String getAncestorName​(WebFolder folder)
        Get the name of an ancestor folder.
        Parameters:
        folder - the ancestor folder
        Returns:
        the name of the folder
        Since:
        MicroStrategy Web 9.0.0

      • isAdvancedAreaExpanded

        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.
        Since:
        MicroStrategy Web 9.0.0

      • getCssClassName

        public java.lang.String getCssClassName​(java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportID

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getMessageID

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getMessageCreationTime

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getMessageModificationTime

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportType

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getJobID

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getModifiedInformation

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getStartTime

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getFinishTime

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getObjectPathFolderAncestors

        public java.util.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)
        Since:
        MicroStrategy Web 9.0.0

      • getReportName

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportDescription

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportOwner

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportStatus

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderAdvancedAreaExpanded

        public boolean shouldRenderAdvancedAreaExpanded()
        Check to see if advanced area should be rendered.
        Returns:
        true if necessary; false otherwise
        Since:
        MicroStrategy Web 9.0.0

      • getTotalRows

        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
        Since:
        MicroStrategy Web 9.0.0

      • getTotalColumns

        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
        Since:
        MicroStrategy Web 9.0.0

      • getServerName

        public java.lang.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.
        Since:
        MicroStrategy Web 9.0.0

      • getAdvancedDivId

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportDetails

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getReportSQL

        public java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of the transform
        Specified by:
        getDescription in interface Transform
        Returns:
        the description of the transform

      • canTransform

        public boolean canTransform​(Transformable data)
        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 AbstractTransform
        Parameters:
        data - the bean that will transformed.
        Returns:
        true if the data is a RWBean.

      • renderMessage

        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.

      • renderOwner

        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.

      • renderServerName

        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.

      • renderDocumentID

        public void renderDocumentID​(MarkupOutput out)
        Renders the document ID information for the RWDocumentDetails instance of the RWBean being transformed.
        Parameters:
        out - MarkupOutput

      • renderDescription

        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.

      • renderPath

        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.

      • renderDataSetStartTime

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

      • renderDataSetFinishTime

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

      • renderDataSetServerName

        @Deprecated
public void renderDataSetServerName​(MarkupOutput out,
                                    WebMessage wm)
        Deprecated.
        not used anymore
        Renders the server name 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.

      • renderDataSetMessageID

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

      • renderDataSetID

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

      • renderDataSetMessageCreated

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

      • renderDataSetMessageUpdated

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

      • renderDataSetName

        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.

      • renderDataSetOwner

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

      • renderDataSetStatus

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

      • checkLevel

        @Deprecated
public boolean checkLevel​(int level)
        Deprecated.
        Check if the level parameter value contains this flag. This method calls checkLevel(FormalParameter, int) using the levelFlag parameter
        Parameters:
        level - flag value to check
        Returns:
        true means the level flag is included in the levelFlag formal parameter value
        Since:
        MicroStrategy Web 9.0.0

      • isAdvancedAreaVisible

        @Deprecated
public boolean isAdvancedAreaVisible()
        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.
        Since:
        MicroStrategy Web 9.0.0

      • getChildrenMessages

        @Deprecated
public WebMessages getChildrenMessages()
        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.

      • getShowDetailsEvent

        protected WebEvent getShowDetailsEvent()
        Generate the WebEvent instance to be used for showing the details of the document (to refresh the page information). the EnumServletEvents.WebEventGetDocumentDetails event, or null if it is not supported by the application
        Since:
        MicroStrategy Web 9.0.0

      • getRWDetails

        protected RWDocumentDetails getRWDetails()
        Since:
        MicroStrategy Web 9.0.0

      • getExecuteDocumentEvent

        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 EnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE event, or null if it is not supported by the application
        Since:
        MicroStrategy Web 9.0.0

      • getDatasetStatus

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

      • getExecuteDocumentEvent

        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 EnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE event, or null if it is not supported by the application

      • getRWDocumentPathTransform

        @Deprecated
protected TransformInstance getRWDocumentPathTransform​(RWBean rw)
        Deprecated.
        not used anymore