Class RWDetailsTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractWebBeanTransform
-
- com.microstrategy.web.app.transforms.AbstractRWTransform
-
- com.microstrategy.web.app.transforms.RWDetailsTransform
-
- 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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
AbstractRWTransform.ButtonAlignmentsHelper
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description static int
DATASET_LEVEL_ALL
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_CREATED_INFO
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_FINISH_TIME
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_LAST_UPDATE_INFO
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_MESSAGE_ID
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_OWNER
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_REPORT_ID
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_SERVER_NAME
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_START_TIME
Deprecated.please use the layout xmlstatic int
DATASET_LEVEL_STATUS
Deprecated.please use the layout xmlFormalParameter
datasetDisplayLevelFlag
Deprecated.please use the layout xmlFormalParameter
documentDisplayLevelFlag
Deprecated.please use the layout xmlFormalParameter
documentPathStyle
Deprecated.please use the layout xmlstatic 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.static 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.static 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.static int
LEVEL_ALL
Deprecated.use layout instead.static int
LEVEL_DATASET_INFO
Deprecated.please use the layout xmlstatic int
LEVEL_DESCRIPTION
Deprecated.please use the layout xmlstatic int
LEVEL_DOCUMENT_ID
Deprecated.please use the layout xmlstatic int
LEVEL_MESSAGE_ID
Deprecated.please use the layout xmlstatic int
LEVEL_NAME
Deprecated.please use the layout xmlstatic int
LEVEL_OWNER
Deprecated.please use the layout xmlstatic int
LEVEL_PATH
Deprecated.please use the layout xmlstatic int
LEVEL_SERVER_NAME
Deprecated.please use the layout xml-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
imgError
-
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 RWDetailsTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canTransform(Transformable data)
Overrides canTransform by returning always true.boolean
checkLevel(int level)
Deprecated.java.lang.String
getAdvancedDivId()
Generate the id of the div which holds advaned detail information for the document.java.lang.String
getAdvancedDivId(RWDataSetDetails details)
Generate the id of the div which holds advaned detail information for theRWDataSetDetails
instance of an individual dataset.java.lang.String
getAncestorName(WebFolder folder)
Get the name of an ancestor folder.SimpleList
getAncestors(RWDetails details)
Retrieves the ancestors of theRWDetails
instance.WebMessages
getChildrenMessages()
Deprecated.not used any morejava.lang.String
getCssClassName(java.lang.String cssName)
Generate the css class name used by this transform.java.util.List
getDatasets()
Returns all the datasets based on theRWDocumentDetails
instance of theRWBean
being transformed.protected java.lang.String
getDatasetStatus(int status)
Based on the status code of the object, obtain the descriptor to be shown to the userjava.lang.String
getDescription()
Returns the textual description of the transformjava.lang.String
getDocumentID()
Get the document identifier based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getDocumentStatus()
Get the document status based on theRWDocumentDetails
instance of theRWBean
being transformed.protected WebEvent
getExecuteDocumentEvent(RWDetails details)
Obtain the event to be used for executing the report writing document.protected WebEvent
getExecuteDocumentEvent(RWMessage rwm)
Obtain the event to be used for executing the report writing document.java.lang.String
getFinishTime()
Get the message finish time based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getFinishTime(RWDataSetDetails details)
Get the message finish time based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getJobID()
Get the job identifier based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getJobID(RWDataSetDetails details)
Get the job identifier based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getMessageCreationTime()
Get the message creation time based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getMessageCreationTime(RWDataSetDetails details)
Get the message creation time based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getMessageID()
Get the document name based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getMessageID(RWDataSetDetails details)
Get the message identifier based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getMessageModificationTime()
Get the message modification time based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getMessageModificationTime(RWDataSetDetails details)
Get the message modification time based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getMessageName()
Get the document name based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getModifiedInformation()
Get the modification time based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getModifiedInformation(RWDataSetDetails details)
Get the modification time based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getObjectName()
java.util.List
getObjectPathFolderAncestors(int rootIndex)
Returns all the ancestors of the documentjava.util.List
getObjectPathFolderAncestors(int rootIndex, RWDetails details)
Returns all the ancestors of theRWDetails
instancejava.lang.String
getOwner()
Get the owner based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getProjectName()
java.lang.String
getReportDescription(RWDataSetDetails datasetDetails)
Get the report(dataset) description based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getReportDetails(RWDataSetDetails details)
Get report details from theRWDataSetDetails
of an individual dataset.java.lang.String
getReportID(RWDataSetDetails details)
Get the report identifier based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getReportName(RWDataSetDetails datasetDetails)
Get the report name based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getReportOwner(RWDataSetDetails datasetDetails)
Get the owner based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getReportSQL(RWDataSetDetails details)
Get report SQL from theRWDataSetDetails
of an individual dataset.java.lang.String
getReportStatus(RWDataSetDetails details)
Get the report(dataset) status on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getReportType(RWDataSetDetails details)
Get the report type based on theRWDataSetDetails
instance of an individual dataset.java.lang.String
getRWDescription()
Get the document description based on theRWDocumentDetails
instance of theRWBean
being transformed.protected RWDocumentDetails
getRWDetails()
protected RWMessage
getRWDocumentMessage()
protected TransformInstance
getRWDocumentPathTransform(RWBean rw)
Deprecated.not used anymorejava.lang.String
getServerName()
Get the server name based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getServerName(RWDataSetDetails details)
Get the server name based on theRWDataSetDetails
instance of an individual dataset.protected WebEvent
getShowDetailsEvent()
Generate theWebEvent
instance to be used for showing the details of the document (to refresh the page information).java.lang.String
getStartTime()
Get the message start time based on theRWDocumentDetails
instance of theRWBean
being transformed.java.lang.String
getStartTime(RWDataSetDetails details)
Get the message start time based on theRWDataSetDetails
instance of an individual dataset.int
getTotalColumns(RWDataSetDetails details)
Get the total number of columns returned based on theRWDataSetDetails
instance of an individual dataset.int
getTotalRows(RWDataSetDetails details)
Get the total number of rows returned based on theRWDataSetDetails
instance of an individual dataset.WebEvent
getWebReexecuteEvent()
Returns the reexecute event Always get the event from the servlet.protected void
initializeRWDetails()
protected void
initializeRWDocumentMessage()
void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.boolean
isAdvancedAreaExpanded()
Determines based on the formal parameter if the advanced detail information are is requested to be expanded or notboolean
isAdvancedAreaVisible()
Deprecated.use layout instead.void
renderAdvancedAreaJavaScript(MarkupOutput out)
Renders JavaScript (if any) that will be related with the advanced information area for the document.void
renderAdvancedDetailsButton(MarkupOutput out)
Renders the button to toggle advanced detail area for document.void
renderAdvancedDetailsButton(MarkupOutput out, boolean requestExpand, RWDataSetDetails details)
Render the button that will allow users to show or not the advanced details information about the individual dataset.void
renderAdvancedDetailsButton(MarkupOutput out, RWDataSetDetails details)
Renders the button to toggle advanced detail area for an individual datasetvoid
renderDataSetFinishTime(MarkupOutput out, WebMessage wm)
Renders the finish time information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetID(MarkupOutput out, WebMessage wm)
Renders the identifier information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetMessageCreated(MarkupOutput out, WebMessage wm)
Renders the message created information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetMessageID(MarkupOutput out, WebMessage wm)
Renders the message identifier information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetMessageUpdated(MarkupOutput out, WebMessage wm)
Renders the message updated information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetName(MarkupOutput out, WebMessage wm)
Renders the name information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetOwner(MarkupOutput out, WebMessage wm)
Renders the owner information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetServerName(MarkupOutput out, WebMessage wm)
Deprecated.not used anymorevoid
renderDataSetStartTime(MarkupOutput out, WebMessage wm)
Renders the start time information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDataSetStatus(MarkupOutput out, WebMessage wm)
Renders the status information for theWebMessage
of the data set child instance of theRWBean
being transformed.void
renderDescription(MarkupOutput out)
Renders the description information forRWDocumentDetails
instance of theRWBean
being transformed.void
renderDocumentID(MarkupOutput out)
Renders the document ID information for theRWDocumentDetails
instance of theRWBean
being transformed.void
renderMessage(MarkupOutput out)
Renders the message identifier information for theRWBean
being transformed.void
renderName(MarkupOutput out)
Generate the HTML with the report writing document title information.void
renderOwner(MarkupOutput out)
Renders the owner information forRWDocumentDetails
instance of theRWBean
being transformed.void
renderPath(MarkupOutput out)
Renders the path information for the theRWDocumentDetails
instance of theRWBean
being transformed.void
renderServerName(MarkupOutput out)
Renders the server name information for theRWDocumentDetails
instance of theRWBean
being transformed.void
renderToggleAdvancedArea(MarkupOutput out, RWDataSetDetails details)
Render the toogleAdvancedArea javascript code based on theRWDataSetDetails
instance of an individual dataset.boolean
shouldRenderAdvancedAreaExpanded()
Check to see if advanced area should be rendered.void
transformForRequestInError(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "Error".void
transformForRequestProcessing(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing).void
transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status which is transformed by this transform is "Successful".void
transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
displayError, generateErrorForIframe, getCancelEvent, getContinueEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getSupportedBeanType, getViewDetailsEvent, initializeImages, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestNotInited, updateVisTransform
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, 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, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, 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.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
LEVEL_NAME
public static final int LEVEL_NAME
Deprecated.please use the layout xmlAllowed value for thedocumentDisplayLevelFlag
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
public static final int LEVEL_DESCRIPTION
Deprecated.please use the layout xmlAllowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's description.
Value = 2- See Also:
- Constant Field Values
-
LEVEL_SERVER_NAME
public static final int LEVEL_SERVER_NAME
Deprecated.please use the layout xmlAllowed value for thedocumentDisplayLevelFlag
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
public static final int LEVEL_OWNER
Deprecated.please use the layout xmlAllowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's owner.
Value = 8- See Also:
- Constant Field Values
-
LEVEL_DATASET_INFO
public static final int LEVEL_DATASET_INFO
Deprecated.please use the layout xmlAllowed value for thedocumentDisplayLevelFlag
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
public static final int LEVEL_PATH
Deprecated.please use the layout xmlAllowed value for thedocumentDisplayLevelFlag
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
public static final int LEVEL_MESSAGE_ID
Deprecated.please use the layout xmlAllowed value for thelevelFlag
formal parameter. Specifies that the transform will display the object's message identifier information.
Value = 128- See Also:
- Constant Field Values
-
LEVEL_DOCUMENT_ID
public static final int LEVEL_DOCUMENT_ID
Deprecated.please use the layout xmlAllowed value for thelevelFlag
formal parameter. Specifies that the transform will display the object's document identifier information.
Value = 256- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
Deprecated.use layout instead.Allowed value for thedocumentDisplayLevelFlag
formal parameter. Convenience flag to indicate all possible DOCUMENT_DISPLAY_LEVEL values.
Value = 16777215- See Also:
- Constant Field Values
-
DATASET_LEVEL_MESSAGE_ID
public static final int DATASET_LEVEL_MESSAGE_ID
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_REPORT_ID
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_STATUS
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_CREATED_INFO
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_LAST_UPDATE_INFO
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_START_TIME
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_FINISH_TIME
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_OWNER
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_SERVER_NAME
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
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
public static final int DATASET_LEVEL_ALL
Deprecated.please use the layout xmlAllowed value for thedatasetDisplayLevelFlag
formal parameter. Convenience flag to indicate all possible DATASET_DISPLAY_LEVEL values.
Value = 16777215- See Also:
- Constant Field Values
-
documentDisplayLevelFlag
public FormalParameter documentDisplayLevelFlag
Deprecated.please use the layout xmlIndicates 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 asLEVEL_PATH
,LEVEL_SERVER_NAME
, etc. For a complete list, refer toRWDetailsTransform
.
Usage: If title and server name should be displayed, the value to assign to the formal parameter would be 5 (1 + 4). Default value isLEVEL_ALL
-
datasetDisplayLevelFlag
public FormalParameter datasetDisplayLevelFlag
Deprecated.please use the layout xmlIndicates 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 asDATASET_LEVEL_MESSAGE_ID
,DATASET_LEVEL_REPORT_ID
,DATASET_LEVEL_STATUS
, etc. For a complete list, refer toRWDetailsTransform
.
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 isDATASET_LEVEL_ALL
-
documentPathStyle
public FormalParameter documentPathStyle
Deprecated.please use the layout xmlThe 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
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractRWTransform
- Parameters:
data
- the bean to transform.- Since:
- MicroStrategy Web 9.0.0
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "Error".- Overrides:
transformForRequestInError
in classAbstractRWTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)". Just forwards to the successfull transform;- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestProcessing
public void transformForRequestProcessing(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing). Just forwards to the successful transform;- Overrides:
transformForRequestProcessing
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status which is transformed by this transform is "Successful".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.details
- theRWDataSetDetails
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
- theRWDataSetDetails
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
- theMarkupOutput
instance where the contents of this transform will be savedrequestExpand
- whether the button will be rendered as already expanded or notdetails
- theRWDataSetDetails
instance associated with the individual dataset- Since:
- MicroStrategy Web 9.0.0
-
getMessageName
public java.lang.String getMessageName()
Get the document name based on theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- the job identifier
- Since:
- MicroStrategy Web 9.0.0
-
getOwner
public java.lang.String getOwner()
Get the owner based on theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- the owner
- Since:
- MicroStrategy Web 9.0.0
-
getRWDescription
public java.lang.String getRWDescription()
Get the document description based on theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- the document description
- Since:
- MicroStrategy Web 9.0.0
-
getModifiedInformation
public java.lang.String getModifiedInformation()
Get the modification time based on theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- the modification time
- Since:
- MicroStrategy Web 9.0.0
-
getDocumentStatus
public java.lang.String getDocumentStatus()
Get the document status based on theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- the document identifier
- Since:
- MicroStrategy Web 9.0.0
-
getProjectName
public java.lang.String getProjectName()
- 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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
being transformed.- Returns:
- a list of datasets
- Since:
- MicroStrategy Web 9.0.0
-
getAncestors
public SimpleList getAncestors(RWDetails details)
Retrieves the ancestors of theRWDetails
instance.- Parameters:
details
- theRWDetails
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
-
getWebReexecuteEvent
public WebEvent getWebReexecuteEvent()
Description copied from class:AbstractWebBeanTransform
Returns the reexecute event Always get the event from the servlet.- Overrides:
getWebReexecuteEvent
in classAbstractRWTransform
- Returns:
- the web reexecute event
- Since:
- MicroStrategy Web 8.0.1
-
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDetails
instance- Parameters:
rootIndex
- , indicates the starting index of the ancestordetails
- theRWDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
datasetDetails
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
datasetDetails
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
datasetDetails
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
instance of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 theRWDataSetDetails
of an individual dataset.- Parameters:
details
- theRWDataSetDetails
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 interfaceTransform
- 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 interfaceTransform
- Overrides:
canTransform
in classAbstractTransform
- 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 theRWBean
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 forRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
being transformed.- Parameters:
out
- MarkupOutput
-
renderDescription
public void renderDescription(MarkupOutput out)
Renders the description information forRWDocumentDetails
instance of theRWBean
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 theRWDocumentDetails
instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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
public void renderDataSetServerName(MarkupOutput out, WebMessage wm)
Deprecated.not used anymoreRenders the server name information for theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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 theWebMessage
of the data set child instance of theRWBean
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
public boolean checkLevel(int level)
Deprecated.Check if the level parameter value contains this flag. This method callscheckLevel(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
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
public WebMessages getChildrenMessages()
Deprecated.not used any moreObtain theWebMessage
children instances that are defined for the currentRWMessage
of theRWBean
being transformed- Returns:
WebMessages
initialized instance with the information of the child data set messages defined.
-
getShowDetailsEvent
protected WebEvent getShowDetailsEvent()
Generate theWebEvent
instance to be used for showing the details of the document (to refresh the page information). theEnumServletEvents.WebEventGetDocumentDetails
event, ornull
if it is not supported by the application- Since:
- MicroStrategy Web 9.0.0
-
getRWDocumentMessage
protected RWMessage getRWDocumentMessage()
- Returns:
RWMessage
instance of theDocumentBean
being transformed.
-
getRWDetails
protected RWDocumentDetails getRWDetails()
- Since:
- MicroStrategy Web 9.0.0
-
initializeRWDocumentMessage
protected void initializeRWDocumentMessage() throws WebBeanException, WebObjectsException
Obtains theRWMessage
instance out of theRWBean
being transformed, for initializing the property of this transform.- Throws:
WebBeanException
- if any error happens while initializing the informationWebObjectsException
- if any error happens while initializing the information
-
initializeRWDetails
protected void initializeRWDetails() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
- if any error happens while initializing the informationWebObjectsException
- if any error happens while initializing the information- 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 theRWBean
beings displayed.- Returns:
- a
WebEvent
instance to execute the report writing document message. By default it returns theEnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE
event, ornull
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 theRWBean
beings displayed.- Returns:
- a
WebEvent
instance to execute the report writing document message. By default it returns theEnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE
event, ornull
if it is not supported by the application
-
getRWDocumentPathTransform
protected TransformInstance getRWDocumentPathTransform(RWBean rw)
Deprecated.not used anymore
-
-