Class ReportDetailsTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractWebBeanTransform
-
- com.microstrategy.web.app.transforms.AbstractReportTransform
-
- com.microstrategy.web.app.transforms.ReportDetailsTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ReportDetailsTransform extends AbstractReportTransform
Deprecated.UseReportDetailsXHTMLTransform
instead.This transform is used to show details of a report. It has details like report name, report path, report SQL, report filters and some other things.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
cssReportFilterHeader
Deprecated.protected java.lang.String
cssReportFilterTable
Deprecated.protected java.lang.String
cssReportFilterTextArea
Deprecated.protected java.lang.String
cssReportNameProperty
Deprecated.protected java.lang.String
cssReportNameTable
Deprecated.protected java.lang.String
cssReportNameValue
Deprecated.protected java.lang.String
cssReportPromptHeader
Deprecated.protected java.lang.String
cssReportPromptTable
Deprecated.protected java.lang.String
cssReportPropertyName
Deprecated.protected java.lang.String
cssReportPropertyValue
Deprecated.protected java.lang.String
cssReportSQLHeader
Deprecated.protected java.lang.String
cssReportSQLTable
Deprecated.protected java.lang.String
cssReportSQLTextArea
Deprecated.protected java.lang.String
cssReportTemplateDetailsHeader
Deprecated.protected java.lang.String
cssReportTemplateDetailsTable
Deprecated.protected java.lang.String
cssReportTemplateDetailsTextArea
Deprecated.protected java.lang.String
cssReportViewFilterHeader
Deprecated.protected java.lang.String
cssReportViewFilterTable
Deprecated.protected java.lang.String
cssReportViewFilterTextArea
Deprecated.protected FormalParameter
expandEmbeddedFilter
Deprecated.Indicates whether or not to show simply the shortcut name or the expanded expression.protected FormalParameter
isDataSet
Deprecated.protected FormalParameter
reportFilterTxtAreaCols
Deprecated.Parameter to specify the number of columns for the Report Filter Textarea.protected FormalParameter
reportFilterTxtAreaRows
Deprecated.Parameter to specify the number of rows for the Report Filter Textarea.protected FormalParameter
reportPathStylePara
Deprecated.Parameter to specify the Style name used to show the report path.protected FormalParameter
reportPromptDetailsStylePara
Deprecated.Parameter to specify the Style name used to show the prompt details.protected FormalParameter
showHRLine1Para
Deprecated.Flag used to decide if we need to show the first HR on the transform.protected FormalParameter
showHRLine2Para
Deprecated.Flag used to decide if we need to show the second HR on the transform.protected FormalParameter
showHRLine3Para
Deprecated.Flag used to decide if we need to show the third HR on the transform.protected FormalParameter
showParentFolderPara
Deprecated.Flag used to decide if we need to show Report Parent Folder Name.protected FormalParameter
showReportBaseFilterNamePara
Deprecated.Flag used to decide if we need to show the Report Base Filter name.protected FormalParameter
showReportDescriptionPara
Deprecated.Flag used to decide if we need to show the Report Description.protected FormalParameter
showReportFilterPara
Deprecated.Flag used to decide if we need to show the Report Filter details.protected FormalParameter
showReportFinishTimePara
Deprecated.Flag used to decide if we need to show the Report Finish time.protected FormalParameter
showReportIDPara
Deprecated.Flag used to decide if we need to show the total ReportID.protected FormalParameter
showReportLimitPara
Deprecated.Flag used to decide if we need to show the Report Template Limit.protected FormalParameter
showReportMessageCreatedPara
Deprecated.Flag used to decide if we need to show the Report Message Created time.protected FormalParameter
showReportMessagePara
Deprecated.Flag used to decide if we need to show the Report MessageID.protected FormalParameter
showReportMessageUpdatedPara
Deprecated.Flag used to decide if we need to show the Report Message Updated time.protected FormalParameter
showReportNamePara
Deprecated.Flag used to decide if we need to show Report Name.protected FormalParameter
showReportOwnerPara
Deprecated.Flag used to decide if we need to show the Report Owner.protected FormalParameter
showReportPathPara
Deprecated.Flag used to decide if we need to show the Report Path.protected FormalParameter
showReportPromptDetailsPara
Deprecated.Flag used to decide if we need to show the Report Prompt details.protected FormalParameter
showReportSQLPara
Deprecated.Flag used to decide if we need to show the Report SQL details.protected FormalParameter
showReportStartTimePara
Deprecated.Flag used to decide if we need to show the Report Start time.protected FormalParameter
showReportStatusPara
Deprecated.Flag used to decide if we need to show the Report Status.protected FormalParameter
showReportTemplateDetailsPara
Deprecated.Flag used to decide if we need to show the Report Template details.protected FormalParameter
showReportTemplatePara
Deprecated.Flag used to decide if we need to show the Report Template name.protected FormalParameter
showReportTotColsPara
Deprecated.Flag used to decide if we need to show the total columns in the report.protected FormalParameter
showReportTotRowsPara
Deprecated.Flag used to decide if we need to show the total rows in the report.protected FormalParameter
showReportViewFilterPara
Deprecated.Flag used to decide if we need to show the Report View Filter details.protected FormalParameter
showServerNamePara
Deprecated.Flag used to decide if we need to show the Server Name.protected FormalParameter
sqlTxtAreaCols
Deprecated.Parameter to specify the number of columns for the SQL Textarea.protected FormalParameter
sqlTxtAreaRows
Deprecated.Parameter to specify the number of rows for the SQL Textarea.protected FormalParameter
templateDetailsTxtAreaCols
Deprecated.Parameter to specify the number of columns for the Template Details Textarea.protected FormalParameter
templateDetailsTxtAreaRows
Deprecated.Parameter to specify the number of rows for the Template Details Textarea.protected FormalParameter
viewFilterTxtAreaCols
Deprecated.Parameter to specify the number of columns for the View Filter Textarea.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
BLANK_SUBSET_REPORT_ID, BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width
-
-
Constructor Summary
Constructors Constructor Description ReportDetailsTransform()
Deprecated.Default no-args constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canTransform(Transformable data)
Deprecated.Overrides canTransform by returning always true.java.lang.String
getDescription()
Deprecated.Returns the description for this Transformjava.lang.String
getReportStatus(int status)
Deprecated.ExtendsgetReportStatus()
by providing custom message for some statusjava.lang.Class
getSupportedBeanType()
Deprecated.return the bean type supported by this transform.protected void
getTemplateDetails(java.util.Hashtable templateDetails)
Deprecated.This method will put two new Strings on the templateDetails table the keys will be "METRIC" and "ATTRIBUTE" The content of the METRICS string will be, for each metric, its name followed by the description in case that it is present otherwise the metric formula and the metric conditionality using the WebReportData.getMetricFormula and getMetricConditionality methods.void
initializeCss()
Deprecated.Initialize the css classes to be used by this transform.protected void
renderFilterName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the filter name if the formal parameter showReportBaseFilterNamePara is true, there is no error in the report as stated by the reportInError variable, base filter name retrieved from the reportBean data using the getBaseFilterName method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 645:"Filter:" and the second one the string that the returned by getBaseFilterName() HTML encodedprotected void
renderFinishTime(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportFinishTimePara is true, there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 655:"Finish Time:" and the second one the string that the method _wm.getRequestFinishTime() returns only if this is not null and the length is greater than zero HTML encoded, otherwise will render the message contained in the descriptor 3755:"Job is still running"protected void
renderMessageCreated(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the creation time of the web message if the formal parameter showReportMessageCreatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getCreationTime() is not null and _wm.getCreationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 652:"Message Created:" and the second one the string that the method _wm.getCreationTime() returns HTML encodedprotected void
renderMessageID(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the message ID of the WebMessage _wm parameter if the formal parameter showReportMessagePara is true, the id of _wm, if _wm is not null and the id is not null and its length is greater than zero, or the reportBean messageID is not null and its length greater than zero.protected void
renderMessageUpdated(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportMessageUpdatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getModificationTime() is not null and _wm.getModificationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 653:"Message last updated:" and the second one the string that the method _wm.getModificationTime() returns HTML encodedprotected void
renderParentFolderName(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the parent folder name if the showParentFolderPara formal parameter is true and there is no error in report as stated in the reportInError variable and the WebMessage.getFolderName method returns some string who its lenght is greater than 0 and not null.protected void
renderPromptDetails(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render on the out variable a table with the descriptor 1309:"Prompt Details" and the result of the PromptsBean transform method using the style stated in the formal parameter reportPromptDetailsStylePara.protected void
renderReportDescription(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encodedprotected void
renderReportFilter(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportFilterPara is true.protected void
renderReportID(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the object ID of the WebMessage _wm parameter if the formal parameter showReportIDPara is true, the object id of _wm, if _wm is not null and the object id is not null and its length is greater than zero, or the reportBean objectID is not null and its length greater than zero.protected void
renderReportLimit(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report limit if the formal parameter showReportLimitPara is true, there is no error in the report as stated by the reportInError variable, the template limit retrieved from the reportBean data using the getTemplateLimit() method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 1121:"Report Limit:" and the second one the string that the returned by getTemplateLimit()protected void
renderReportName(MarkupOutput out, WebMessage _wm)
Deprecated.Will render a table with the report name as a link when the WebMessage is different of null and the report allows execution, plain text otherwise.protected void
renderReportOwner(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report owner if the formal parameter showReportOwnerPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectCreator() is not null and _wm.getObjectCreator() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 60:"Owner:" and the second one the string that the method _wm.getObjectCreator() returns HTML encodedprotected void
renderReportPath(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report path if the formal parameter showReportPathPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 650:"Report path:" and the second one the report path string that the method getReportPath() returnsprotected void
renderReportSQL(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the MDX statement if the report is a MDX report or the SQL statement of the report otherwise, will print the descriptor 1097:"The SQL generation is not complete" if the SQL is null or length zeroprotected void
renderReportStatus(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report status if the formal parameter showReportStatusPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 187:"Status:" and the second one the string that the method getReportStatus(_wm.getRequestStatus()) returnsprotected void
renderServerName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of server name if the formal parameter showServerNamePara is true, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 36:"Server Name:" and the second one the string that the method getServerName of the WebIServerSession class returns HTML encodedprotected void
renderStartTime(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportStartTimePara is true, there is no error in the report as stated by the reportInError variable, _wm.getRequestStartTime() is not null and _wm.getRequestStartTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 188:"Start time:" and the second one the string that the method _wm.getRequestStartTime() returnsprotected void
renderTemplateDetails(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the template details if the reportInError variable is false and the template details txt area rows and the template details txt area cols, the template details metrics and attributes.protected void
renderTemplateName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encodedprotected void
renderTotalColumns(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of total columns in the report if the formal parameter showReportTotColsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 649:"Total number of columns:" and the second one the totalColumns that the method getGridTotalColumns of the WebReportData class returnsprotected void
renderTotalRows(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of total rows in the report if the formal parameter showReportTotRowsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 648:"Total number of rows:" and the second one the totalRows that the method getGridTotalRows of the WebReportData class returnsprotected void
renderViewFilter(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the view filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportViewFilterPara is true.void
transformForRequestInError(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is in "Error".void
transformForRequestProcessing(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing).void
transformForRequestSuccessful(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is "Successfull".void
transformForRequestWaitingForUserInput(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatusDescriptorKey, getRepromptEvent, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, initializeProperties, initializeTransform, initializeWebComponent, isCubeReport, isDatamart, isDesignMode, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestNotInited, useBuiltInFormat
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.transform.Transform
getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
showReportNamePara
protected FormalParameter showReportNamePara
Deprecated.Flag used to decide if we need to show Report Name.
Allowed Values: TRUE / FALSE
-
showReportTotRowsPara
protected FormalParameter showReportTotRowsPara
Deprecated.Flag used to decide if we need to show the total rows in the report.
Allowed Values: TRUE / FALSE
-
showReportTotColsPara
protected FormalParameter showReportTotColsPara
Deprecated.Flag used to decide if we need to show the total columns in the report.
Allowed Values: TRUE / FALSE
-
showReportIDPara
protected FormalParameter showReportIDPara
Deprecated.Flag used to decide if we need to show the total ReportID.
Allowed Values: TRUE / FALSE
-
showReportMessagePara
protected FormalParameter showReportMessagePara
Deprecated.Flag used to decide if we need to show the Report MessageID.
Allowed Values: TRUE / FALSE
-
showReportStatusPara
protected FormalParameter showReportStatusPara
Deprecated.Flag used to decide if we need to show the Report Status.
Allowed Values: TRUE / FALSE
-
showReportMessageCreatedPara
protected FormalParameter showReportMessageCreatedPara
Deprecated.Flag used to decide if we need to show the Report Message Created time.
Allowed Values: TRUE / FALSE
-
showReportMessageUpdatedPara
protected FormalParameter showReportMessageUpdatedPara
Deprecated.Flag used to decide if we need to show the Report Message Updated time.
Allowed Values: TRUE / FALSE
-
showReportStartTimePara
protected FormalParameter showReportStartTimePara
Deprecated.Flag used to decide if we need to show the Report Start time.
Allowed Values: TRUE / FALSE
-
showReportFinishTimePara
protected FormalParameter showReportFinishTimePara
Deprecated.Flag used to decide if we need to show the Report Finish time.
Allowed Values: TRUE / FALSE
-
showParentFolderPara
protected FormalParameter showParentFolderPara
Deprecated.Flag used to decide if we need to show Report Parent Folder Name.
Allowed Values: TRUE / FALSE
-
showServerNamePara
protected FormalParameter showServerNamePara
Deprecated.Flag used to decide if we need to show the Server Name.
Allowed Values: TRUE / FALSE
-
showReportPathPara
protected FormalParameter showReportPathPara
Deprecated.Flag used to decide if we need to show the Report Path.
Allowed Values: TRUE / FALSE
-
showReportOwnerPara
protected FormalParameter showReportOwnerPara
Deprecated.Flag used to decide if we need to show the Report Owner.
Allowed Values: TRUE / FALSE
-
showReportDescriptionPara
protected FormalParameter showReportDescriptionPara
Deprecated.Flag used to decide if we need to show the Report Description.
Allowed Values: TRUE / FALSE
-
showReportBaseFilterNamePara
protected FormalParameter showReportBaseFilterNamePara
Deprecated.Flag used to decide if we need to show the Report Base Filter name.
Allowed Values: TRUE / FALSE
-
showReportLimitPara
protected FormalParameter showReportLimitPara
Deprecated.Flag used to decide if we need to show the Report Template Limit.
Allowed Values: TRUE / FALSE
-
showReportTemplatePara
protected FormalParameter showReportTemplatePara
Deprecated.Flag used to decide if we need to show the Report Template name.
Allowed Values: TRUE / FALSE
-
showHRLine1Para
protected FormalParameter showHRLine1Para
Deprecated.Flag used to decide if we need to show the first HR on the transform.
Allowed Values: TRUE / FALSE
-
showHRLine2Para
protected FormalParameter showHRLine2Para
Deprecated.Flag used to decide if we need to show the second HR on the transform.
Allowed Values: TRUE / FALSE
-
showHRLine3Para
protected FormalParameter showHRLine3Para
Deprecated.Flag used to decide if we need to show the third HR on the transform.
Allowed Values: TRUE / FALSE
-
showReportFilterPara
protected FormalParameter showReportFilterPara
Deprecated.Flag used to decide if we need to show the Report Filter details.
Allowed Values: TRUE / FALSE
-
showReportViewFilterPara
protected FormalParameter showReportViewFilterPara
Deprecated.Flag used to decide if we need to show the Report View Filter details.
Allowed Values: TRUE / FALSE
-
showReportTemplateDetailsPara
protected FormalParameter showReportTemplateDetailsPara
Deprecated.Flag used to decide if we need to show the Report Template details.
Allowed Values: TRUE / FALSE
-
showReportPromptDetailsPara
protected FormalParameter showReportPromptDetailsPara
Deprecated.Flag used to decide if we need to show the Report Prompt details.
Allowed Values: TRUE / FALSE
-
showReportSQLPara
protected FormalParameter showReportSQLPara
Deprecated.Flag used to decide if we need to show the Report SQL details.
Allowed Values: TRUE / FALSE
-
reportFilterTxtAreaRows
protected FormalParameter reportFilterTxtAreaRows
Deprecated.Parameter to specify the number of rows for the Report Filter Textarea.
Allowed Values: integer values
-
reportFilterTxtAreaCols
protected FormalParameter reportFilterTxtAreaCols
Deprecated.Parameter to specify the number of columns for the Report Filter Textarea.
Allowed Values: integer values
-
viewFilterTxtAreaCols
protected FormalParameter viewFilterTxtAreaCols
Deprecated.Parameter to specify the number of columns for the View Filter Textarea.
Allowed Values: integer values
-
templateDetailsTxtAreaRows
protected FormalParameter templateDetailsTxtAreaRows
Deprecated.Parameter to specify the number of rows for the Template Details Textarea.
Allowed Values: integer values
-
templateDetailsTxtAreaCols
protected FormalParameter templateDetailsTxtAreaCols
Deprecated.Parameter to specify the number of columns for the Template Details Textarea.
Allowed Values: integer values
-
sqlTxtAreaRows
protected FormalParameter sqlTxtAreaRows
Deprecated.Parameter to specify the number of rows for the SQL Textarea.
Allowed Values: integer values
-
sqlTxtAreaCols
protected FormalParameter sqlTxtAreaCols
Deprecated.Parameter to specify the number of columns for the SQL Textarea.
Allowed Values: integer values
-
reportPathStylePara
protected FormalParameter reportPathStylePara
Deprecated.Parameter to specify the Style name used to show the report path. This has to match one of the styles specified in the page config file.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportPromptDetailsStylePara
protected FormalParameter reportPromptDetailsStylePara
Deprecated.Parameter to specify the Style name used to show the prompt details. This has to match one of the styles specified in the page config file for this page.
Allowed Values: any report style name from StyelCatalog.xml file.
-
expandEmbeddedFilter
protected FormalParameter expandEmbeddedFilter
Deprecated.Indicates whether or not to show simply the shortcut name or the expanded expression.- Since:
- MicroStrategy Web 7.5.4
-
isDataSet
protected FormalParameter isDataSet
Deprecated.This is the formal parameter which indicates if the object being displayed corresponds to a Data Set object or not.
Allowed Values: TRUE/FALSE- Since:
- MicroStrategy Web 7.5.0
-
cssReportNameTable
protected java.lang.String cssReportNameTable
Deprecated.
-
cssReportNameProperty
protected java.lang.String cssReportNameProperty
Deprecated.
-
cssReportNameValue
protected java.lang.String cssReportNameValue
Deprecated.
-
cssReportPropertyName
protected java.lang.String cssReportPropertyName
Deprecated.
-
cssReportPropertyValue
protected java.lang.String cssReportPropertyValue
Deprecated.
-
cssReportFilterTable
protected java.lang.String cssReportFilterTable
Deprecated.
-
cssReportFilterHeader
protected java.lang.String cssReportFilterHeader
Deprecated.
-
cssReportFilterTextArea
protected java.lang.String cssReportFilterTextArea
Deprecated.
-
cssReportViewFilterTable
protected java.lang.String cssReportViewFilterTable
Deprecated.
-
cssReportViewFilterHeader
protected java.lang.String cssReportViewFilterHeader
Deprecated.
-
cssReportViewFilterTextArea
protected java.lang.String cssReportViewFilterTextArea
Deprecated.
-
cssReportTemplateDetailsTable
protected java.lang.String cssReportTemplateDetailsTable
Deprecated.
-
cssReportTemplateDetailsHeader
protected java.lang.String cssReportTemplateDetailsHeader
Deprecated.
-
cssReportTemplateDetailsTextArea
protected java.lang.String cssReportTemplateDetailsTextArea
Deprecated.
-
cssReportPromptTable
protected java.lang.String cssReportPromptTable
Deprecated.
-
cssReportPromptHeader
protected java.lang.String cssReportPromptHeader
Deprecated.
-
cssReportSQLTable
protected java.lang.String cssReportSQLTable
Deprecated.
-
cssReportSQLHeader
protected java.lang.String cssReportSQLHeader
Deprecated.
-
cssReportSQLTextArea
protected java.lang.String cssReportSQLTextArea
Deprecated.
-
-
Method Detail
-
initializeCss
public void initializeCss()
Deprecated.Initialize the css classes to be used by this transform.- Overrides:
initializeCss
in classAbstractAppTransform
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is in "Error".- Overrides:
transformForRequestInError
in classAbstractReportTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)". Just forwards to the successfull transform;- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- Output by this transform- Since:
- MicroStrategy Web 7.5.0
- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestProcessing
public void transformForRequestProcessing(MarkupOutput out)
Deprecated.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;- Overrides:
transformForRequestProcessing
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- Since:
- MicroStrategy Web 7.5.3
- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Deprecated.Transform when the bean status which is transformed by this transform is "Successfull".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getTemplateDetails
protected void getTemplateDetails(java.util.Hashtable templateDetails)
Deprecated.This method will put two new Strings on the templateDetails table the keys will be "METRIC" and "ATTRIBUTE" The content of the METRICS string will be, for each metric, its name followed by the description in case that it is present otherwise the metric formula and the metric conditionality using the WebReportData.getMetricFormula and getMetricConditionality methods. Ths content of the ATTRIBUTE string will be, for each attribute, the name followed by the description in the case that is present, otherwise the string contained on the descriptor 1131:"Information not available"- Parameters:
templateDetails
-
-
getReportStatus
public java.lang.String getReportStatus(int status)
Deprecated.ExtendsgetReportStatus()
by providing custom message for some status- Overrides:
getReportStatus
in classAbstractReportTransform
- Parameters:
status
- The message status- Returns:
- The string description of the status
-
renderReportName
protected void renderReportName(MarkupOutput out, WebMessage _wm)
Deprecated.Will render a table with the report name as a link when the WebMessage is different of null and the report allows execution, plain text otherwise. The method will get the execution event from the WebMessage using the getExecuteEvent(WebMessage) and render an anchor tag using the generateAnchor(WebEvent) method.- Parameters:
out
- where the output will be rendered_wm
- the webMessage used to create the link
-
renderParentFolderName
protected void renderParentFolderName(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the parent folder name if the showParentFolderPara formal parameter is true and there is no error in report as stated in the reportInError variable and the WebMessage.getFolderName method returns some string who its lenght is greater than 0 and not null. The method is going to try to see if the folder is using some special description using the FolderNameHelper.getSpecialFolderNameDescription() method if there is no special description then the name will be the string returned by the _wm.getFolderName() method, all this will be rendered inside the 'out' MarkputOutput param as a two span tags one with the descriptor 283:"Parent Folder:" followed by another with the folderName encoded for HTML.- Parameters:
out
-_wm
-
-
renderTotalRows
protected void renderTotalRows(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of total rows in the report if the formal parameter showReportTotRowsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 648:"Total number of rows:" and the second one the totalRows that the method getGridTotalRows of the WebReportData class returns- Parameters:
out
-_wm
- not used at all
-
renderTotalColumns
protected void renderTotalColumns(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of total columns in the report if the formal parameter showReportTotColsPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 649:"Total number of columns:" and the second one the totalColumns that the method getGridTotalColumns of the WebReportData class returns- Parameters:
out
-_wm
- not used at all
-
renderServerName
protected void renderServerName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the number of server name if the formal parameter showServerNamePara is true, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 36:"Server Name:" and the second one the string that the method getServerName of the WebIServerSession class returns HTML encoded- Parameters:
out
-_wm
- not used at all
-
renderReportPath
protected void renderReportPath(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report path if the formal parameter showReportPathPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 650:"Report path:" and the second one the report path string that the method getReportPath() returns- Parameters:
out
-_wm
- not used at all
-
renderMessageID
protected void renderMessageID(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the message ID of the WebMessage _wm parameter if the formal parameter showReportMessagePara is true, the id of _wm, if _wm is not null and the id is not null and its length is greater than zero, or the reportBean messageID is not null and its length greater than zero. This will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 80:"Message ID:" and the second one the _wm.getID() or the messageID of the report bean in the case that _vm and _vm.getID() are null or not valid- Parameters:
out
-_wm
-
-
renderReportID
protected void renderReportID(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the object ID of the WebMessage _wm parameter if the formal parameter showReportIDPara is true, the object id of _wm, if _wm is not null and the object id is not null and its length is greater than zero, or the reportBean objectID is not null and its length greater than zero. This will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 77:"Report ID:" and the second one the _wm.getObjectID() or the ObjectID of the report bean in the case that _vm and _vm.getObjectID() are null or not valid- Parameters:
out
-_wm
-
-
renderReportStatus
protected void renderReportStatus(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report status if the formal parameter showReportStatusPara is true and there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 187:"Status:" and the second one the string that the method getReportStatus(_wm.getRequestStatus()) returns- Parameters:
out
-_wm
-
-
renderMessageCreated
protected void renderMessageCreated(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the creation time of the web message if the formal parameter showReportMessageCreatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getCreationTime() is not null and _wm.getCreationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 652:"Message Created:" and the second one the string that the method _wm.getCreationTime() returns HTML encoded- Parameters:
out
-_wm
-
-
renderMessageUpdated
protected void renderMessageUpdated(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportMessageUpdatedPara is true, there is no error in the report as stated by the reportInError variable, _wm.getModificationTime() is not null and _wm.getModificationTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 653:"Message last updated:" and the second one the string that the method _wm.getModificationTime() returns HTML encoded- Parameters:
out
-_wm
-
-
renderStartTime
protected void renderStartTime(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportStartTimePara is true, there is no error in the report as stated by the reportInError variable, _wm.getRequestStartTime() is not null and _wm.getRequestStartTime() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 188:"Start time:" and the second one the string that the method _wm.getRequestStartTime() returns- Parameters:
out
-_wm
-
-
renderFinishTime
protected void renderFinishTime(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the modification time of the web message if the formal parameter showReportFinishTimePara is true, there is no error in the report as stated by the reportInError variable, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 655:"Finish Time:" and the second one the string that the method _wm.getRequestFinishTime() returns only if this is not null and the length is greater than zero HTML encoded, otherwise will render the message contained in the descriptor 3755:"Job is still running"- Parameters:
out
-_wm
-
-
renderReportOwner
protected void renderReportOwner(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report owner if the formal parameter showReportOwnerPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectCreator() is not null and _wm.getObjectCreator() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 60:"Owner:" and the second one the string that the method _wm.getObjectCreator() returns HTML encoded- Parameters:
out
-_wm
-
-
renderReportDescription
protected void renderReportDescription(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded- Parameters:
out
-_wm
-
-
renderTemplateName
protected void renderTemplateName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report description if the formal parameter showReportDescriptionPara is true, there is no error in the report as stated by the reportInError variable, _wm.getObjectDescription() is not null and _wm.getObjectDescription() string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 643:"Report Description:" and the second one the string that the method _wm.getObjectDescription() returns HTML encoded- Parameters:
out
-_wm
- not used
-
renderFilterName
protected void renderFilterName(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the filter name if the formal parameter showReportBaseFilterNamePara is true, there is no error in the report as stated by the reportInError variable, base filter name retrieved from the reportBean data using the getBaseFilterName method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 645:"Filter:" and the second one the string that the returned by getBaseFilterName() HTML encoded- Parameters:
out
-_wm
- not used
-
renderReportLimit
protected void renderReportLimit(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report limit if the formal parameter showReportLimitPara is true, there is no error in the report as stated by the reportInError variable, the template limit retrieved from the reportBean data using the getTemplateLimit() method is not null and the string length is greater than zero, this will be rendered in the 'out' MarkputOutput parameter as two span tags, the first one contains the descriptor 1121:"Report Limit:" and the second one the string that the returned by getTemplateLimit()- Parameters:
out
-_wm
- not used
-
renderReportFilter
protected void renderReportFilter(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the report filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportFilterPara is true. If reportInError variable is true 1131:"Information not available" will be placed inside the text area, otherwise it will append the tranformation of the filter expression using the ExpressionPlainTextTransform if the filter is not empty or the descriptor 179:"Filter empty" and also shows the template metric limit if it is not null also in the text area.- Parameters:
out
-_wm
- not used
-
renderViewFilter
protected void renderViewFilter(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render the view filter description in a table with the descriptor 1983:"Report Filter" followed by a text area, if the formal parameter showReportViewFilterPara is true. If reportInError variable is true 1131:"Information not available" will be placed inside the text area, otherwise it will append the tranformation of the filter expression using the ExpressionPlainTextTransform if the filter is not empty or the descriptor 179:"Filter empty" also in the text area.- Parameters:
out
-_wm
- not used
-
renderTemplateDetails
protected void renderTemplateDetails(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the template details if the reportInError variable is false and the template details txt area rows and the template details txt area cols, the template details metrics and attributes.- Parameters:
out
-_wm
- not used
-
renderPromptDetails
protected void renderPromptDetails(MarkupOutput out, WebMessage _wm)
Deprecated.Method will render on the out variable a table with the descriptor 1309:"Prompt Details" and the result of the PromptsBean transform method using the style stated in the formal parameter reportPromptDetailsStylePara.- Parameters:
out
-_wm
- not used
-
renderReportSQL
protected void renderReportSQL(MarkupOutput out, WebMessage _wm)
Deprecated.Will render the MDX statement if the report is a MDX report or the SQL statement of the report otherwise, will print the descriptor 1097:"The SQL generation is not complete" if the SQL is null or length zero- Parameters:
out
-_wm
- not used
-
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 interfaceTransform
- Overrides:
canTransform
in classAbstractReportTransform
- Parameters:
data
- the report bean that will transformed.- Returns:
- true if the data is a ReportBean.
- Since:
- MicroStrategy Web 7.5.0
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Deprecated.Description copied from class:AbstractReportTransform
return the bean type supported by this transform.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractReportTransform
- Returns:
- the bean type
-
getDescription
public java.lang.String getDescription()
Deprecated.Returns the description for this Transform- Returns:
- Description for this Transform
-
-