Class SubscriptionSendNowTransform
- 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.SubscriptionSendNowTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class SubscriptionSendNowTransform extends SubscriptionEditTransform
This class renders the output to create a Send Now subscription.
It supports creating send now subscriptions for prompted and non-prompted reports. It uses aSubscriptionBean
for this.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 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 SubscriptionSendNowTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebEvent
getAddEvent()
The event to create a new send now subscription.java.lang.String
getDescription()
Returns the description of this transform.WebEvent
getReturnEvent()
The event to trigger after the subscription is saved correctly.com.microstrategy.web.app.transforms.SendNowWidget
getSendNowWidget()
The send now widget used to render the fields to send the email.java.lang.String
getTitle()
Title for the dialogvoid
renderSchedulePane(MarkupOutput out)
Renders the fields to create a SendNow Subscription.-
Methods inherited from class com.microstrategy.web.app.transforms.SubscriptionEditTransform
getAddressEvent, getAvailableTriggers, getCancelEvent, getCurrentFormat, getPersonalizationLinkEvent, getPromptsBean, getSubscriptionBean, getSubscriptionWidget, getSupportedBeanType, getUpdatePropertiesEvent, getViewMode, initializeTransform, initWidget, renderJobExpiredSection, renderShell, setExpandLayoutProperties, setExpandPageByProperties, supports, transformForRequestInError
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
getDivButtonBar, getPromptsEvent, getPromptsTransform, initHelp, initializeImages, isRWD, isSubscriptionFromSaveAs, renderCancelButton, renderExecuteButtons, renderFormEnd, renderFormStart, renderIconPane, renderImage, renderPrompts, setSubscribeFromSaveAs, shouldDisplay, supports, transformForRequestSuccessful, 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
-
-
-
-
Method Detail
-
renderSchedulePane
public void renderSchedulePane(MarkupOutput out)
Renders the fields to create a SendNow Subscription.
It uses aSendNowWidget
for this purpose.- Overrides:
renderSchedulePane
in classSubscriptionEditTransform
- Parameters:
out
- The transform output.
-
getAddEvent
public WebEvent getAddEvent()
The event to create a new send now subscription.- Overrides:
getAddEvent
in classSubscriptionEditTransform
- Returns:
- The
EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE
event.
-
getReturnEvent
public WebEvent getReturnEvent()
The event to trigger after the subscription is saved correctly.- Overrides:
getReturnEvent
in classSubscriptionEditTransform
- 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. - Since:
- MicroStrategy Web 8.0.0
-
getSendNowWidget
public com.microstrategy.web.app.transforms.SendNowWidget getSendNowWidget()
The send now widget used to render the fields to send the email.- Returns:
- A
SendNowWidget
instance.
-
getDescription
public java.lang.String getDescription()
Returns the description of this transform.
This is used in the style catalog editor.- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classSubscriptionEditTransform
- Returns:
- The description of this transform.
-
getTitle
public java.lang.String getTitle()
Description copied from class:AbstractSubscriptionEditTransform
Title for the dialog- Overrides:
getTitle
in classAbstractSubscriptionEditTransform
- Returns:
- the title to be displayed.
- Since:
- MicroStrategy Web 8.0.0
- See Also:
AbstractSubscriptionEditTransform.getTitle()
-
-