Class SubscriptionEditTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
SubscriptionConfirmTransform
,SubscriptionEditFileTransform
,SubscriptionPersonalViewTransform
,SubscriptionSendNowTransform
public class SubscriptionEditTransform extends AbstractSubscriptionEditTransform
This class renders the output to create/edit an email subscription. It supports creating email 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 Modifier and Type Class Description static interface
SubscriptionEditTransform.NCSRecipientContext
class
SubscriptionEditTransform.RecipientContext
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected WebEvent
_addEvent
The event for the creating the subscriptionprotected boolean
_allowSubscription
protected WebEvent
_cancelEvent
The event for the canceling the current actionprotected boolean
_isUserAllowedToSubscribe
protected WebEvent
_personalizationLinkEvent
protected WebEvent
_returnEvent
The event for the returning to the previous stateprotected java.lang.String
_subscribeGraphAsGridGraph
The boolean value to indicate if graphs are to be subscribed as grid-graph.protected SubscriptionBean
_subscriptionBean
protected WebEvent
_updatePropertiesEvent
static java.lang.String
FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
Name for the formal parameterFP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
FormalParameter
subscribeGraphAsGridGraph
Indicates if graphs are to be subscribed as grid-graph.-
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 SubscriptionEditTransform()
Default no argument constructor, initialize formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebEvent
getAddEvent()
The event to create a new subscription.WebEvent
getAddressEvent()
The event to go to the address page.SimpleList
getAvailableTriggers()
Return the list of available triggers for subscription.WebEvent
getCancelEvent()
The event to cancel the subscription.WebSubscriptionContentFormat
getCurrentFormat()
Returns the current format for this subscription used when creating the subscription.java.lang.String
getDescription()
Returns the description of this transform.protected WebEvent
getPersonalizationLinkEvent()
PromptsBean
getPromptsBean()
Return the PromptsBean associated with the SubscriptionBean.WebEvent
getReturnEvent()
The event to trigger after the subscription is saved correctly.protected SubscriptionBean
getSubscriptionBean()
Return the the SubscriptionBean that this transform is going to transform.com.microstrategy.web.app.transforms.SubscriptionWidget
getSubscriptionWidget()
The subscription widget used to render the subscription pane.java.lang.Class
getSupportedBeanType()
Returns the supported bean type for the transform.protected WebEvent
getUpdatePropertiesEvent()
int
getViewMode()
The subscription view mode.void
initializeTransform(Transformable data)
ExtendsinitializeTransform
by keeping its own copy of the data.protected void
initWidget(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent)
void
renderJobExpiredSection(MarkupOutput out)
Renders the job expired section, including an error message and an reexecute buttonvoid
renderSchedulePane(MarkupOutput out)
Renders the schedule pane for the user to subscribe to a report or document.void
renderShell(MarkupOutput out)
Generates the shell for this Transform.protected void
setExpandLayoutProperties(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent)
protected void
setExpandPageByProperties(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent)
setExpandPageByPropertiesboolean
supports(java.lang.Class type)
Overrridessupports
by only supportingSubscriptionBean
.void
transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.-
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, 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
-
-
-
-
Field Detail
-
_subscriptionBean
protected SubscriptionBean _subscriptionBean
- Since:
- MicroStrategy Web 8.0.0
-
_addEvent
protected WebEvent _addEvent
The event for the creating the subscription
-
_updatePropertiesEvent
protected WebEvent _updatePropertiesEvent
- Since:
- MicroStrategy Web 9.0.0
-
_personalizationLinkEvent
protected WebEvent _personalizationLinkEvent
- Since:
- MicroStrategy Web 9.0.0
-
_cancelEvent
protected WebEvent _cancelEvent
The event for the canceling the current action
-
_returnEvent
protected WebEvent _returnEvent
The event for the returning to the previous state
-
_allowSubscription
protected boolean _allowSubscription
- Since:
- MicroStrategy Web 7.5.0
-
_isUserAllowedToSubscribe
protected boolean _isUserAllowedToSubscribe
-
subscribeGraphAsGridGraph
public FormalParameter subscribeGraphAsGridGraph
Indicates if graphs are to be subscribed as grid-graph. If we are subscribing to a graph and this proerty is set to true, then we will create a subscription for a grid-grah rather than a graph. This property is usually mapped to a graph preference which indicates if we want to run all graphs as grid-graphs.
If this formal parameter is set to "1", it will be treated as true.
-
_subscribeGraphAsGridGraph
protected java.lang.String _subscribeGraphAsGridGraph
The boolean value to indicate if graphs are to be subscribed as grid-graph.
-
FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
public static final java.lang.String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
Name for the formal parameterFP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
- 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 classAbstractSubscriptionEditTransform
- Parameters:
data
- the bean to transform.
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
. OverwritestransformForRequestInError
by showing a "The email subscription feature is currently unavailable" message.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- Output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderJobExpiredSection
public void renderJobExpiredSection(MarkupOutput out)
Renders the job expired section, including an error message and an reexecute button- Parameters:
out
- Output by this transform- Since:
- MicroStrategy Web 8.0.1
-
renderShell
public void renderShell(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the shell for this Transform.
The shell is a
The attributes to append to this<div>
tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.<div>
are obtained from thegetAttributesShellDiv
method; the style from thegetStyleShellDiv
method.
This method callsrenderCssLink
andcheckStatus
to generate the Transform's content.- Overrides:
renderShell
in classAbstractAppTransform
- Parameters:
out
- output by this transform
-
renderSchedulePane
public void renderSchedulePane(MarkupOutput out)
Renders the schedule pane for the user to subscribe to a report or document. It uses an instance of theSubscriptionWidget
for this purpose.- Specified by:
renderSchedulePane
in classAbstractSubscriptionEditTransform
- Parameters:
out
- Output by this transform.
-
initWidget
protected void initWidget(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent) throws WebBeanException
- Throws:
WebBeanException
- Since:
- MicroStrategy Web 9.0.0
-
setExpandPageByProperties
protected void setExpandPageByProperties(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent)
setExpandPageByProperties- Parameters:
widget
- SubscriptionWidgetaddEvent
- WebEvent- Since:
- MicroStrategy Web 8.0.0
-
setExpandLayoutProperties
protected void setExpandLayoutProperties(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget, WebEvent addEvent)
- Since:
- MicroStrategy Web 9.0.0
-
getSubscriptionWidget
public com.microstrategy.web.app.transforms.SubscriptionWidget getSubscriptionWidget()
The subscription widget used to render the subscription pane.- Returns:
- A
SubscriptionWidget
instance.
-
getViewMode
public int getViewMode()
The subscription view mode. Possible values areVIEW_MODE_GRID
,VIEW_MODE_GRAPH
,VIEW_MODE_GRID_GRAPH
orVIEW_MODE_DOCUMENT
.- Specified by:
getViewMode
in classAbstractSubscriptionEditTransform
- Returns:
- The view mode of the subscription.
-
getCurrentFormat
public WebSubscriptionContentFormat getCurrentFormat()
Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.- Returns:
- The current subscription format.
-
getDescription
public java.lang.String getDescription()
Returns the description of this transform. This is used in the style catalog editor.- Returns:
- The description of this transform.
-
getAddEvent
public WebEvent getAddEvent()
The event to create a new subscription.- Specified by:
getAddEvent
in classAbstractSubscriptionEditTransform
- Returns:
- The
EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE
event
-
getUpdatePropertiesEvent
protected WebEvent getUpdatePropertiesEvent()
- Specified by:
getUpdatePropertiesEvent
in classAbstractSubscriptionEditTransform
- Since:
- MicroStrategy Web 9.0.0
-
getPersonalizationLinkEvent
protected WebEvent getPersonalizationLinkEvent()
- Specified by:
getPersonalizationLinkEvent
in classAbstractSubscriptionEditTransform
- Since:
- MicroStrategy Web 9.0.0
-
getAddressEvent
public WebEvent getAddressEvent()
The event to go to the address page.- Overrides:
getAddressEvent
in classAbstractSubscriptionEditTransform
- Returns:
- The
EnumServletEvents.WebEventNCAddresses
event
-
getCancelEvent
public WebEvent getCancelEvent()
The event to cancel the subscription.- Specified by:
getCancelEvent
in classAbstractSubscriptionEditTransform
- Returns:
- The
EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_CANCEL
event.
-
getReturnEvent
public WebEvent getReturnEvent()
The event to trigger after the subscription is saved correctly.- Specified by:
getReturnEvent
in classAbstractSubscriptionEditTransform
- 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.
-
getPromptsBean
public PromptsBean getPromptsBean()
Return the PromptsBean associated with the SubscriptionBean.- Specified by:
getPromptsBean
in classAbstractSubscriptionEditTransform
- Returns:
- The
PromptsBean
associated with the SubscriptionBean.
-
supports
public boolean supports(java.lang.Class type)
Overrridessupports
by only supportingSubscriptionBean
.- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractSubscriptionEditTransform
- Parameters:
type
- The bean type.- Returns:
- true if bean is assignable to a SubscriptionBean.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type for the transform.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- The
SubscriptionBean
bean for this transform.
-
getAvailableTriggers
public SimpleList getAvailableTriggers()
Return the list of available triggers for subscription.- Specified by:
getAvailableTriggers
in classAbstractSubscriptionEditTransform
- Returns:
- The list of Available triggers.
-
getSubscriptionBean
protected SubscriptionBean getSubscriptionBean()
Return the the SubscriptionBean that this transform is going to transform.- Returns:
- A
SubscriptionBean
instance - Since:
- MicroStrategy Web 7.5.1
-
-