Package com.microstrategy.web.app.transforms

Class ScheduleEditTransform

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.ScheduleEditTransform

All Implemented Interfaces:

AppTransform, Transform

public class ScheduleEditTransform
extends AbstractSubscriptionEditTransform

Deprecated.

Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use SubscriptionEditTransform instead

This class renders the output to create/edit a WebSchedule (Web-subscription). It supports creating subscriptions for prompted and non-prompted reports. It uses a ScheduleBean for this.

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 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
ScheduleEditTransform()	Deprecated. Default no-args constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
WebEvent	getAddEvent()	Deprecated. The event to create a new scheduled subscription.
SimpleList	getAvailableTriggers()	Deprecated. Returns the list of Available triggers.
WebEvent	getCancelEvent()	Deprecated. The event to cancel editing the subscription.
java.lang.String	getDescription()	Deprecated. Returns the description of this transform.
protected WebEvent	getPersonalizationLinkEvent()	Deprecated.
PromptsBean	getPromptsBean()	Deprecated. Return the PromptsBean associated with the ScheduleBean.
WebEvent	getReturnEvent()	Deprecated. The event to trigger after the schedule is saved correctly.
ScheduleWidget	getScheduleWidget()	Deprecated. The schedule widget used to enable the user to schedule a report or a document.
java.lang.Class	getSupportedBeanType()	Deprecated. Returns the supported bean type for the transform.
protected WebEvent	getUpdatePropertiesEvent()	Deprecated.
int	getViewMode()	Deprecated. The schedule view mode.
void	initializeTransform(Transformable data)	Deprecated. Extends initializeTransform by keeping its own copy of the data.
void	renderSchedulePane(MarkupOutput out)	Deprecated. Renders the list of schedules for the user to subscribe.
boolean	supports(java.lang.Class type)	Deprecated. Overrrides supports by only supporting ScheduleBean.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform

getAddressEvent, 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, 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, getFormalParams, getPreview, isPreviewAvailable, isResolved

Constructor Detail

ScheduleEditTransform

public ScheduleEditTransform()

Deprecated.

Default no-args constructor, initialize formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Deprecated.

Extends initializeTransform 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 interface AppTransform

Overrides:

initializeTransform in class AbstractSubscriptionEditTransform

Parameters:

data - the bean to transform.

renderSchedulePane

public void renderSchedulePane(MarkupOutput out)

Deprecated.

Renders the list of schedules for the user to subscribe. It uses a ScheduleWidget to accomplish this.

Specified by:

renderSchedulePane in class AbstractSubscriptionEditTransform

Parameters:

out - The transform output.

getScheduleWidget

public ScheduleWidget getScheduleWidget()

Deprecated.

The schedule widget used to enable the user to schedule a report or a document.

Returns:

a ScheduleWidget instance.

getViewMode

public int getViewMode()

Deprecated.

The schedule view mode. Possible values are VIEW_MODE_GRID, VIEW_MODE_GRAPH or VIEW_MODE_DOCUMENT.

Specified by:

getViewMode in class AbstractSubscriptionEditTransform

Returns:

The view mode of the schedule.

getDescription

public java.lang.String getDescription()

Deprecated.

Returns the description of this transform. This is used in the style catalog editor.

Returns:

The description of this transform.

getAddEvent

public WebEvent getAddEvent()

Deprecated.

The event to create a new scheduled subscription.

Specified by:

getAddEvent in class AbstractSubscriptionEditTransform

Returns:

The EnumScheduleBeanEvents.SCHEDULE_EVENT_SAVE event.

getCancelEvent

public WebEvent getCancelEvent()

Deprecated.

The event to cancel editing the subscription.

Specified by:

getCancelEvent in class AbstractSubscriptionEditTransform

Returns:

The EnumScheduleBeanEvents.SCHEDULE_EVENT_CANCEL event.

getReturnEvent

public WebEvent getReturnEvent()

Deprecated.

The event to trigger after the schedule is saved correctly.

Specified by:

getReturnEvent in class AbstractSubscriptionEditTransform

Returns:

By default, the EnumServletEvents.WebEventCancel event, however if coming from the SaveAs page, it returns the EnumServletEvents.WebEventOpenObjectSubscriptions, to go to the list of subscriptions.

getPromptsBean

public PromptsBean getPromptsBean()

Deprecated.

Return the PromptsBean associated with the ScheduleBean.

Specified by:

getPromptsBean in class AbstractSubscriptionEditTransform

Returns:

The PromptsBean associated with the ScheduleBean.

supports

public boolean supports(java.lang.Class type)

Deprecated.

Overrrides supports by only supporting ScheduleBean.

Specified by:

supports in interface Transform

Overrides:

supports in class AbstractSubscriptionEditTransform

Parameters:

type - The bean type.

Returns:

true if bean is assignable to a ScheduleBean.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Deprecated.

Returns the supported bean type for the transform.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

The ScheduleBean bean for this transform.

getAvailableTriggers

public SimpleList getAvailableTriggers()

Deprecated.

Returns the list of Available triggers.

Specified by:

getAvailableTriggers in class AbstractSubscriptionEditTransform

Returns:

The list of Available triggers.

getUpdatePropertiesEvent

protected WebEvent getUpdatePropertiesEvent()

Deprecated.

Specified by:

getUpdatePropertiesEvent in class AbstractSubscriptionEditTransform

Since:

MicroStrategy Web 9.0.0

getPersonalizationLinkEvent

protected WebEvent getPersonalizationLinkEvent()

Deprecated.

Specified by:

getPersonalizationLinkEvent in class AbstractSubscriptionEditTransform

Since:

MicroStrategy Web 9.0.0