Class AbstractSubscriptionEditTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
ScheduleEditTransform
,SubscriptionEditTransform
public abstract class AbstractSubscriptionEditTransform extends AbstractAppTransform
AbstractSubscriptionEditTransform is an abstract class which acts as a super class for all subscription and schedule transforms. Copyright: Copyright (c) 2001- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
_helpTopic
protected java.lang.String
_helpType
FormalParameter
datamartImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.FormalParameter
documentImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.FormalParameter
formID
The ID and the name to use for the subscriptions's HTML FORM tag.static java.lang.String
FP_FORM_ID
Name for the Formal parameterFP_FORM_ID
static java.lang.String
FP_HELP_TOPIC
Constant specifying the name of the formal parameter for specifying the help topic for the help of the editorstatic java.lang.String
FP_HELP_TYPE
Constant specifying the type of the help file this editor should point tostatic java.lang.String
FP_IMG_DATAMART
Name for the Formal parameterFP_IMG_DATAMART
static java.lang.String
FP_IMG_DOCUMENT
Name for the Formal parameterFP_IMG_DOCUMENT
static java.lang.String
FP_IMG_GRAPH
Name for the Formal parameterFP_IMG_GRAPH
static java.lang.String
FP_IMG_GRID
Name for the Formal parameterFP_IMG_GRID
static java.lang.String
FP_IMG_GRID_GRAPH
Name for the Formal parameterFP_IMG_GRID_GRAPH
static java.lang.String
FP_IMG_RW_DOCUMENT
Name for the Formal parameterFP_IMG_RW_DOCUMENT
static java.lang.String
FP_PROMPTS_TRANSFORM_STYLE
Name for the Formal parameterFP_PROMPTS_TRANSFORM_STYLE
FormalParameter
graphImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.FormalParameter
gridGraphImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.FormalParameter
gridImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.FormalParameter
helpTopic
Indicates the help topic for the help page of the editor.FormalParameter
helpType
Indicates the type of help topic this editor uses.java.lang.String
PROMPTS_TRANSFORM_STYLE
Deprecated.Please use thepromptsTransformStyle
Formal Parameter insteadFormalParameter
promptsTransformStyle
Name of the style to apply for rendering prompts on this transform.FormalParameter
rwDocumentImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.java.lang.String
SUBSCRIBE_FROM_SAVEAS
int
VIEW_MODE_BULK_EXPORT
One of the values for the View Mode property in this transformint
VIEW_MODE_CUBE
One of the values for the View Mode property in this transformint
VIEW_MODE_DATAMART
One of the values for the View Mode property in this transformint
VIEW_MODE_DOCUMENT
One of the values for the View Mode property in this transformint
VIEW_MODE_GRAPH
One of the values for the View Mode property in this transformint
VIEW_MODE_GRID
One of the values for the View Mode property in this transformint
VIEW_MODE_GRID_GRAPH
One of the values for the View Mode property in this transformint
VIEW_MODE_RW_DOCUMENT
One of the values for the View Mode property in this transform-
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 AbstractSubscriptionEditTransform()
Default no argument constructor, initialize formal parameters.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract WebEvent
getAddEvent()
Event to create a new subscription or schedule.WebEvent
getAddressEvent()
The event to open the Narrowcast address page.abstract SimpleList
getAvailableTriggers()
List of available triggers.abstract WebEvent
getCancelEvent()
The event to cancel the subscription or schedule.protected Tag
getDivButtonBar()
protected abstract WebEvent
getPersonalizationLinkEvent()
abstract PromptsBean
getPromptsBean()
Return the prompts bean associated with the SubscriptionBean or ScheduleBeanWebEvent
getPromptsEvent()
The event to answer prompts.protected TransformInstance
getPromptsTransform(PromptsBean promptsBean)
Return the transform instance associated with the promptsBean.abstract WebEvent
getReturnEvent()
The event to execute if the the subscription or schedule is created successfully.java.lang.String
getTitle()
Title for the dialogprotected abstract WebEvent
getUpdatePropertiesEvent()
abstract int
getViewMode()
The schedule or subscription view mode.protected void
initHelp()
void
initializeImages()
Initialize the images to be used by this transform.void
initializeTransform(Transformable data)
ExtendsinitializeTransform
by keeping its own copy of the data.boolean
isRWD()
Determine whether the current object is a RW Documentboolean
isSubscriptionFromSaveAs()
Returns whether the subscription was triggered from the Save As page.protected void
renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.void
renderExecuteButtons(MarkupOutput out)
Render the execute buttons (Ok-Cancel)void
renderFormEnd(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM end tag.void
renderFormStart(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM start tag.void
renderIconPane(MarkupOutput out)
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.void
renderImage(MarkupOutput out, java.lang.String image)
Renders an image for this transformvoid
renderPrompts(MarkupOutput out)
Render the prompts content.abstract void
renderSchedulePane(MarkupOutput out)
Renders the pane containing the list of schedulesvoid
setSubscribeFromSaveAs(boolean subscribeFromSaveAs)
Sets the value of the SubscribeFromSaveAs from the request to a property of the transformprotected boolean
shouldDisplay()
Determines whether the transform should render itself or not.boolean
supports(Transformable data)
Overwritessupports
by only supporting Subscription and Schedule Beans.boolean
supports(java.lang.Class type)
Overwritessupports
by only supporting Subscription and Schedule Beans.void
transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful".void
transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status is "WaitingForUserInput".-
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, getSupportedBeanType, 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, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, transform, transformForRequestCanceled, transformForRequestInError, 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, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved
-
-
-
-
Field Detail
-
PROMPTS_TRANSFORM_STYLE
public java.lang.String PROMPTS_TRANSFORM_STYLE
Deprecated.Please use thepromptsTransformStyle
Formal Parameter instead
-
FP_PROMPTS_TRANSFORM_STYLE
public static final java.lang.String FP_PROMPTS_TRANSFORM_STYLE
Name for the Formal parameterFP_PROMPTS_TRANSFORM_STYLE
- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_IMG_GRAPH
public static final java.lang.String FP_IMG_GRAPH
Name for the Formal parameterFP_IMG_GRAPH
- See Also:
- Constant Field Values
-
FP_IMG_GRID
public static final java.lang.String FP_IMG_GRID
Name for the Formal parameterFP_IMG_GRID
- See Also:
- Constant Field Values
-
FP_IMG_DATAMART
public static final java.lang.String FP_IMG_DATAMART
Name for the Formal parameterFP_IMG_DATAMART
- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
FP_IMG_GRID_GRAPH
public static final java.lang.String FP_IMG_GRID_GRAPH
Name for the Formal parameterFP_IMG_GRID_GRAPH
- See Also:
- Constant Field Values
-
FP_IMG_DOCUMENT
public static final java.lang.String FP_IMG_DOCUMENT
Name for the Formal parameterFP_IMG_DOCUMENT
- See Also:
- Constant Field Values
-
FP_IMG_RW_DOCUMENT
public static final java.lang.String FP_IMG_RW_DOCUMENT
Name for the Formal parameterFP_IMG_RW_DOCUMENT
- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
FP_FORM_ID
public static final java.lang.String FP_FORM_ID
Name for the Formal parameterFP_FORM_ID
- See Also:
- Constant Field Values
-
VIEW_MODE_GRID
public final int VIEW_MODE_GRID
One of the values for the View Mode property in this transform- See Also:
- Constant Field Values
-
VIEW_MODE_GRAPH
public final int VIEW_MODE_GRAPH
One of the values for the View Mode property in this transform- See Also:
- Constant Field Values
-
VIEW_MODE_GRID_GRAPH
public final int VIEW_MODE_GRID_GRAPH
One of the values for the View Mode property in this transform- See Also:
- Constant Field Values
-
VIEW_MODE_DOCUMENT
public final int VIEW_MODE_DOCUMENT
One of the values for the View Mode property in this transform- See Also:
- Constant Field Values
-
VIEW_MODE_RW_DOCUMENT
public final int VIEW_MODE_RW_DOCUMENT
One of the values for the View Mode property in this transform- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
VIEW_MODE_DATAMART
public final int VIEW_MODE_DATAMART
One of the values for the View Mode property in this transform- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
VIEW_MODE_CUBE
public final int VIEW_MODE_CUBE
One of the values for the View Mode property in this transform- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
VIEW_MODE_BULK_EXPORT
public final int VIEW_MODE_BULK_EXPORT
One of the values for the View Mode property in this transform- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
SUBSCRIBE_FROM_SAVEAS
public final java.lang.String SUBSCRIBE_FROM_SAVEAS
- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
promptsTransformStyle
public FormalParameter promptsTransformStyle
Name of the style to apply for rendering prompts on this transform.- Since:
- MicroStrategy Web 8.0.0
-
graphImage
public FormalParameter graphImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a graph.
-
gridGraphImage
public FormalParameter gridGraphImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a grid-graph.
-
gridImage
public FormalParameter gridImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a grid.
-
datamartImage
public FormalParameter datamartImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a datamart.- Since:
- MicroStrategy Web 7.5.0
-
documentImage
public FormalParameter documentImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a document.
-
rwDocumentImage
public FormalParameter rwDocumentImage
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Name of the image used to depict a subscription to a report writing document.- Since:
- MicroStrategy Web 7.5.0
-
formID
public FormalParameter formID
The ID and the name to use for the subscriptions's HTML FORM tag.
-
helpType
public FormalParameter helpType
Indicates the type of help topic this editor uses.- Since:
- MicroStrategy Web 9.0.0
-
helpTopic
public FormalParameter helpTopic
Indicates the help topic for the help page of the editor.- Since:
- MicroStrategy Web 9.0.0
-
FP_HELP_TYPE
public static final java.lang.String FP_HELP_TYPE
Constant specifying the type of the help file this editor should point to- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_HELP_TOPIC
public static final java.lang.String FP_HELP_TOPIC
Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
_helpTopic
protected java.lang.String _helpTopic
- Since:
- MicroStrategy Web 9.0.0
-
_helpType
protected java.lang.String _helpType
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful". Just calls transformForRequestWaitingForUserInput, which is the correct status. This transform, after collecting and saving the information, expects to go back to its previous page.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- 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 is "WaitingForUserInput". This is the main state when creating a new subscrription or schedule.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- Output by this transform.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getUpdatePropertiesEvent
protected abstract WebEvent getUpdatePropertiesEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getPersonalizationLinkEvent
protected abstract WebEvent getPersonalizationLinkEvent()
- Since:
- MicroStrategy Web 9.0.0
-
initHelp
protected void initHelp()
- Since:
- MicroStrategy Web 9.0.0
-
renderFormStart
public void renderFormStart(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM start tag.- Parameters:
out
- Output by this transform.hasOpenPrompts
- true if there are open prompts in this subscription.
-
renderFormEnd
public void renderFormEnd(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM end tag.- Parameters:
out
- Output by this transformhasOpenPrompts
- true if there are open prompts in this subscription.
-
renderIconPane
public void renderIconPane(MarkupOutput out)
Deprecated.We no longer render the images when the user tries to edit/create a new subscription.Renders The icon pane, based on the view mode- Parameters:
out
- the transform's output.
-
shouldDisplay
protected boolean shouldDisplay()
Description copied from class:AbstractAppTransform
Determines whether the transform should render itself or not. Returns the result of !AbstractAppTransform.isIFrameRequest()
or the result of theWebComponent.hasChanged()
method.- Overrides:
shouldDisplay
in classAbstractAppTransform
- Returns:
- boolean
- Since:
- MicroStrategy Web 9.0.0
-
getPromptsTransform
protected TransformInstance getPromptsTransform(PromptsBean promptsBean)
Return the transform instance associated with the promptsBean. If the Formal ParameterFP_PROMPTS_TRANSFORM_STYLE
is set, it will add that style to the bean and return the transform instance. If not, it will return a new instance of PromptsSubscriptionTransform.- Parameters:
promptsBean
- the prompts bean to transform- Returns:
- the Transform Instance.
- Since:
- MicroStrategy Web 8.0.0
-
renderPrompts
public void renderPrompts(MarkupOutput out)
Render the prompts content.
It just ask the prompts bean to transform itself using thePROMPTS_TRANSFORM_STYLE
style.- Parameters:
out
- the transform's output.
-
renderExecuteButtons
public void renderExecuteButtons(MarkupOutput out)
Render the execute buttons (Ok-Cancel)- Parameters:
out
- The transform's output.
-
getDivButtonBar
protected Tag getDivButtonBar()
- Since:
- MicroStrategy Web 9.0.0
-
renderCancelButton
protected void renderCancelButton(MarkupOutput out)
Description copied from class:AbstractAppTransform
Renders the Cancel button for the wait page.
It callsAbstractAppTransform.getCancelEvent()
to obtain the event for the button
The button is not rendered if:
-AbstractAppTransform.getCancelEvent()
returns null
-AbstractAppTransform.processingButtonsFlags
does not haveAbstractAppTransform.PROCESSING_BUTTONS_CANCEL
- Overrides:
renderCancelButton
in classAbstractAppTransform
- Parameters:
out
- output for this transform- Since:
- MicroStrategy Web 9.0.0
-
renderSchedulePane
public abstract void renderSchedulePane(MarkupOutput out)
Renders the pane containing the list of schedules- Parameters:
out
- The transform's output.
-
renderImage
public void renderImage(MarkupOutput out, java.lang.String image)
Renders an image for this transform- Overrides:
renderImage
in classAbstractAppTransform
- Parameters:
out
- The transform's output.image
- The image name
-
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 classAbstractAppTransform
- Parameters:
data
- the bean to transform.- Since:
- MicroStrategy Web 8.0.1
-
initializeImages
public void initializeImages()
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
getPromptsEvent
public WebEvent getPromptsEvent()
The event to answer prompts.- Returns:
- The
EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS
event.
-
supports
public boolean supports(Transformable data)
Overwritessupports
by only supporting Subscription and Schedule Beans.- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
data
- The bean to transform.- Returns:
- true if bean is assignable to a SubscriptionBean or ScheduleBean
- See Also:
Transform.canTransform(com.microstrategy.web.beans.Transformable)
-
supports
public boolean supports(java.lang.Class type)
Overwritessupports
by only supporting Subscription and Schedule Beans.- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
type
- The bean type.- Returns:
- true if bean is assignable to a SubscriptionBean or ScheduleBean
-
getTitle
public java.lang.String getTitle()
Title for the dialog- Returns:
- the title to be displayed.
- Since:
- MicroStrategy Web 8.0.0
-
isRWD
public boolean isRWD()
Determine whether the current object is a RW Document- Returns:
- true if the document is a RW Document
- Since:
- MicroStrategy Web 8.0.0
-
isSubscriptionFromSaveAs
public boolean isSubscriptionFromSaveAs()
Returns whether the subscription was triggered from the Save As page.- Returns:
- boolean
- Since:
- MicroStrategy Web 8.0.1
-
setSubscribeFromSaveAs
public void setSubscribeFromSaveAs(boolean subscribeFromSaveAs)
Sets the value of the SubscribeFromSaveAs from the request to a property of the transform- Parameters:
subscribeFromSaveAs
- boolean- Since:
- MicroStrategy Web 8.0.1
-
getViewMode
public abstract int getViewMode()
The schedule or subscription view mode. Possible values areVIEW_MODE_GRID
,VIEW_MODE_GRAPH
,VIEW_MODE_GRID_GRAPH
orVIEW_MODE_DOCUMENT
.- Returns:
- The view mode of the schedule.
-
getAddEvent
public abstract WebEvent getAddEvent()
Event to create a new subscription or schedule.- Returns:
- The event to create a new subscription.
-
getAddressEvent
public WebEvent getAddressEvent()
The event to open the Narrowcast address page.- Returns:
- This method always returns null.
-
getCancelEvent
public abstract WebEvent getCancelEvent()
The event to cancel the subscription or schedule.- Overrides:
getCancelEvent
in classAbstractAppTransform
- Returns:
- The event to cancel the subscription
-
getReturnEvent
public abstract WebEvent getReturnEvent()
The event to execute if the the subscription or schedule is created successfully.- Returns:
- The event to execute once the Subscription has been created succesfully
-
getPromptsBean
public abstract PromptsBean getPromptsBean()
Return the prompts bean associated with the SubscriptionBean or ScheduleBean- Returns:
- the PromptsBean associated with the SubscriptionBean or ScheduleBean
-
getAvailableTriggers
public abstract SimpleList getAvailableTriggers()
List of available triggers.- Returns:
- The list of Available triggers. Based on whether we are rendering subscriptions or schedules, this method will either return the list of available triggers for subscriptions or schedules.
-
-