Class SubscriptionConfirmTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
-
- com.microstrategy.web.app.transforms.SubscriptionEditTransform
-
- com.microstrategy.web.app.transforms.SubscriptionConfirmTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
SubscriptionConfirmSendNowTransform
public class SubscriptionConfirmTransform extends SubscriptionEditTransform
This class renders the confirmation message on a successful Email, File or Print subscription.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.SubscriptionEditTransform
SubscriptionEditTransform.NCSRecipientContext, SubscriptionEditTransform.RecipientContext
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FP_OBJECT_INFO_STYLE
Name for the formal parameter:objectInfoStyle
FormalParameter
objectInfoStyle
Formal parameter: Indicate which style should be used for rendering the object information-
Fields inherited from class com.microstrategy.web.app.transforms.SubscriptionEditTransform
_addEvent, _allowSubscription, _cancelEvent, _isUserAllowedToSubscribe, _personalizationLinkEvent, _returnEvent, _subscribeGraphAsGridGraph, _subscriptionBean, _updatePropertiesEvent, FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH, subscribeGraphAsGridGraph
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
_helpTopic, _helpType, datamartImage, documentImage, formID, FP_FORM_ID, FP_HELP_TOPIC, FP_HELP_TYPE, FP_IMG_DATAMART, FP_IMG_DOCUMENT, FP_IMG_GRAPH, FP_IMG_GRID, FP_IMG_GRID_GRAPH, FP_IMG_RW_DOCUMENT, FP_PROMPTS_TRANSFORM_STYLE, graphImage, gridGraphImage, gridImage, helpTopic, helpType, PROMPTS_TRANSFORM_STYLE, promptsTransformStyle, rwDocumentImage, SUBSCRIBE_FROM_SAVEAS, VIEW_MODE_BULK_EXPORT, VIEW_MODE_CUBE, VIEW_MODE_DATAMART, VIEW_MODE_DOCUMENT, VIEW_MODE_GRAPH, VIEW_MODE_GRID, VIEW_MODE_GRID_GRAPH, VIEW_MODE_RW_DOCUMENT
-
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 SubscriptionConfirmTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns this transform's description.protected WebEvent
getOkEvent()
The event to trigger after the user acknowledges the success message.protected java.lang.String
getTrigger()
Returns the trigger name corresponding of the current subscription.protected WebEvent
getUpdatePropertiesEvent()
void
initializeTransform(Transformable data)
ExtendsinitializeTransform
by keeping its own copy of the data.void
renderButtonBar(MarkupOutput out)
Renders the dialogue buttons of the transformvoid
renderMessageFooter(MarkupOutput out)
Renders the message footer for send now actions or if the send preview option is checked.void
renderMessageTitle(MarkupOutput out)
Renders the successful message.void
renderObject(MarkupOutput out)
Renders the object information of the object to which the subscription is created.void
renderTitle(MarkupOutput out)
Renders the title informing confirmation.void
renderTriggerInfo(MarkupOutput out)
Renders the information about the trigger.void
transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.SubscriptionEditTransform
getAddEvent, getAddressEvent, getAvailableTriggers, getCancelEvent, getCurrentFormat, getPersonalizationLinkEvent, getPromptsBean, getReturnEvent, getSubscriptionBean, getSubscriptionWidget, getSupportedBeanType, getViewMode, initWidget, renderJobExpiredSection, renderSchedulePane, renderShell, setExpandLayoutProperties, setExpandPageByProperties, supports, transformForRequestInError
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
getDivButtonBar, getPromptsEvent, getPromptsTransform, getTitle, initHelp, initializeImages, isRWD, isSubscriptionFromSaveAs, renderCancelButton, renderExecuteButtons, renderFormEnd, renderFormStart, renderIconPane, renderImage, renderPrompts, setSubscribeFromSaveAs, shouldDisplay, supports, transformForRequestWaitingForUserInput
-
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, getRefreshEvent, 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, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated
-
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
canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved
-
-
-
-
Field Detail
-
objectInfoStyle
public FormalParameter objectInfoStyle
Formal parameter: Indicate which style should be used for rendering the object information- Since:
- MicroStrategy Web 9.0.0
-
FP_OBJECT_INFO_STYLE
public static final java.lang.String FP_OBJECT_INFO_STYLE
Name for the formal parameter:objectInfoStyle
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
ExtendsinitializeTransform
by keeping its own copy of the data.
This method initializes the private and protected fields of the transform. It also invokes the initializeTransform method of the parent.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classSubscriptionEditTransform
- Parameters:
data
- the bean to transform.
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful". This transform, after collecting and saving the information, expects to go back to its previous page.- Overrides:
transformForRequestSuccessful
in classAbstractSubscriptionEditTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderTriggerInfo
public void renderTriggerInfo(MarkupOutput out)
Renders the information about the trigger.- Parameters:
out
- The transform's output.
-
renderTitle
public void renderTitle(MarkupOutput out)
Renders the title informing confirmation.- Parameters:
out
- The transform's output.
-
renderMessageTitle
public void renderMessageTitle(MarkupOutput out)
Renders the successful message.- Parameters:
out
- The transform's output.
-
renderButtonBar
public void renderButtonBar(MarkupOutput out)
Renders the dialogue buttons of the transform- Parameters:
out
- The transform's output.
-
renderMessageFooter
public void renderMessageFooter(MarkupOutput out)
Renders the message footer for send now actions or if the send preview option is checked.- Parameters:
out
- The transform's output.
-
renderObject
public void renderObject(MarkupOutput out)
Renders the object information of the object to which the subscription is created.- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.
-
getDescription
public java.lang.String getDescription()
Returns this transform's description.- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classSubscriptionEditTransform
- Returns:
- description for the transform
-
getUpdatePropertiesEvent
protected WebEvent getUpdatePropertiesEvent()
- Overrides:
getUpdatePropertiesEvent
in classSubscriptionEditTransform
-
getOkEvent
protected WebEvent getOkEvent()
The event to trigger after the user acknowledges the success message.- Returns:
- By default, the
EnumServletEvents.WebEventCancel
event, however if coming from the SaveAs page, it returns theEnumServletEvents.WebEventOpenObjectSubscriptions
, to go to the list of subscriptions.
-
getTrigger
protected java.lang.String getTrigger()
Returns the trigger name corresponding of the current subscription.- Returns:
- the name of the trigger
-
-