Package com.microstrategy.web.beans

Class AssociatedSchedulesBeanImpl

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.beans.AbstractTransformable

com.microstrategy.web.beans.AbstractWebComponent

com.microstrategy.web.beans.AssociatedSchedulesBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AssociatedSchedulesBean, RequestPersistable, Transformable, WebBean, WebComponent

public class AssociatedSchedulesBeanImpl
extends AbstractWebComponent
implements AssociatedSchedulesBean

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_hasCollectedData	A flag indicating that the XML request to collect data has been executed
protected int	_status
protected static java.lang.String	ATT_BEAN_TYPE
protected static java.lang.String	ATT_HOW_MUCH_STATE
protected static java.lang.String	ATTRIBUTE_BEAN_HEADER
protected static java.lang.String	DATA_EXPLORER_BEAN_HEADER
protected static java.lang.String	DELIMITOR
protected static java.lang.String	DOCUMENT_BEAN_HEADER
protected static java.lang.String	EXPRESSION_BEAN_HEADER
protected static java.lang.String	FILTER_BEAN_HEADER
protected static java.lang.String	FOLDER_BEAN_HEADER
protected static java.lang.String	INBOX_BEAN_HEADER
protected static java.lang.String	PERFORMANCE_MONITOR_BEAN_HEADER
protected static java.lang.String	PROMPTDEF_BEAN_HEADER
protected static java.lang.String	PROMPTS_BEAN_HEADER
protected static java.lang.String	REPORT_BEAN_HEADER
protected static java.lang.String	RW_BEAN_HEADER
protected static java.lang.String	SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Constructor Summary

Constructors

Constructor	Description
AssociatedSchedulesBeanImpl()

Method Summary

Modifier and Type	Method	Description
protected TransformInstance	addTransform(Transform transform, java.lang.String key)	Adds a transform to itself and all the child beans which support the transform and returns a TransformInstance of the last child bean it was added to.
protected void	checkBeanType(AttributesXt attrs, java.lang.String expected)
protected void	checkHowMuchState(AttributesXt attrs)
void	collectData()	Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData()	This is similar to WebComponent.collectData() except data collected is minimal.
protected void	doCollectData()	Override this method in sub classes to implement the collectData method.
protected void	doCollectMinimalData()
protected void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
MarkupOutput	generateOutput()	This is the generic method to ask the WebComponent to generate some output for the client.
WebAssociatedSchedules	getAssociatedSchedulesForObject()	retrieve the associated schedules with report or RWD
java.lang.String	getDescriptor(int key)
java.lang.String	getDescriptor(java.lang.String key)
org.w3c.dom.Document	getDocument()	Returns a org.w3c.dom.Document parsed from the XML representation of this bean.
WebBeanError	getErrorInfo()	Returns a WebBeanError object indicating processing error during the collectData method call.
WebIServerSubscriptionTrigger	getISSTriger(java.lang.String id)
WebAssociatedSchedules	getProjectAssociatedSchedules()	retrieve the associated schedules with project in the Preference page
WebAssociatedSchedules	getProjectLevelSchedules()	retrieve the associated schedules with project in report or RWD option page
WebSessionInfo	getSessionInfo()	Returns the WebSessionInfo instance from this bean.
protected AbstractHandler	getStateHandler()
TransformInstance	getTransformInstance(java.lang.String key)	Returns the TransformInstance object with the specified key.
java.util.Enumeration	getTransformInstances()	Retuns a java.util.Enumeration over all the TransformInstance objects.
int	getType()	Returns the transformable type as in EnumWebTransformableType.
int	getXMLStatus()	This method returns the EnumRequestStatus status of the current Component.
boolean	hasTransform()	Returns a boolean value indicating whether there is a default TransformInstance object.
boolean	hasTransform(java.lang.String key)	Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.
protected void	internalCollectData()	This method internally calls the method collectData if the method collectData has not yet been called.
protected void	internalCollectData(boolean collectOnError)	Overriding method should not only throw WebBeanException, but also sets error info if possible.
protected void	internalCollectData(boolean collectOnError, boolean collectOnProcessing)	Overriding method should not only throw WebBeanException, but also sets error info if possible.
protected void	invalidateAllTransformCaches()
boolean	isStale()	Returns a boolean value indicating whether the content of this bean is stale.
protected boolean	isTransformSuitable(Transform t)	This method is called in the addTransform methods.
protected BeanContext	newDefaultBeanContext()	This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
protected WebEventHandler	newDefaultEventHandler()
protected StyleRequestContext	newStyleRequestContext()
protected void	reset()
protected void	saveXMLState(XMLStateSerializer builder, int howMuchState)	Saves the component state
protected void	setErrorInfo(WebBeanError beanErr)
void	setSessionInfo(WebSessionInfo sessionInfo)	Sets a new WebSessionInfo instance on this bean.
void	setStale(boolean stale)	Sets a flag indicating whether this bean is stale or fresh.
void	setWebEventHandler(WebEventHandler handler)	Associate with this component a WebEventHandler instance.
void	setXMLStatus(int status)

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasChanged, hasJustOpened, haveChildrenChanged, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, invalidateTransformCache, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, isXMLStateZipped, restoreState, restoreXMLState, saveState, saveState, saveState, saveState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean

getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

FOLDER_BEAN_HEADER

protected static final java.lang.String FOLDER_BEAN_HEADER

See Also:

Constant Field Values

REPORT_BEAN_HEADER

protected static final java.lang.String REPORT_BEAN_HEADER

See Also:

Constant Field Values

PROMPTS_BEAN_HEADER

protected static final java.lang.String PROMPTS_BEAN_HEADER

See Also:

Constant Field Values

DOCUMENT_BEAN_HEADER

protected static final java.lang.String DOCUMENT_BEAN_HEADER

See Also:

Constant Field Values

INBOX_BEAN_HEADER

protected static final java.lang.String INBOX_BEAN_HEADER

See Also:

Constant Field Values

DATA_EXPLORER_BEAN_HEADER

protected static final java.lang.String DATA_EXPLORER_BEAN_HEADER

See Also:

Constant Field Values

RW_BEAN_HEADER

protected static final java.lang.String RW_BEAN_HEADER

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

EXPRESSION_BEAN_HEADER

protected static final java.lang.String EXPRESSION_BEAN_HEADER

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

FILTER_BEAN_HEADER

protected static final java.lang.String FILTER_BEAN_HEADER

See Also:

Constant Field Values

PROMPTDEF_BEAN_HEADER

protected static final java.lang.String PROMPTDEF_BEAN_HEADER

See Also:

Constant Field Values

ATTRIBUTE_BEAN_HEADER

protected static final java.lang.String ATTRIBUTE_BEAN_HEADER

See Also:

Constant Field Values

PERFORMANCE_MONITOR_BEAN_HEADER

protected static final java.lang.String PERFORMANCE_MONITOR_BEAN_HEADER

Since:

MicroStrategy Web 7.5.0

See Also:

Constant Field Values

DELIMITOR

protected static final java.lang.String DELIMITOR

See Also:

Constant Field Values

SEPARATOR

protected static final java.lang.String SEPARATOR

See Also:

Constant Field Values

ATT_BEAN_TYPE

protected static final java.lang.String ATT_BEAN_TYPE

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

ATT_HOW_MUCH_STATE

protected static final java.lang.String ATT_HOW_MUCH_STATE

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

_status

protected int _status

_hasCollectedData

protected boolean _hasCollectedData

A flag indicating that the XML request to collect data has been executed

Constructor Detail

AssociatedSchedulesBeanImpl

public AssociatedSchedulesBeanImpl()

Method Detail

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

doCollectData

protected void doCollectData()
                      throws WebBeanException

Override this method in sub classes to implement the collectData method.

Throws:

WebBeanException

doFlatState

protected void doFlatState(FlatStateSerializer ser,
                           int howMuchState,
                           FlatStateTokenizer tok)

getStateHandler

protected AbstractHandler getStateHandler()

getType

public int getType()

Description copied from interface: Transformable

Returns the transformable type as in EnumWebTransformableType.

Specified by:

getType in interface Transformable

Returns:

the transformable type.

saveXMLState

protected void saveXMLState(XMLStateSerializer builder,
                            int howMuchState)

Description copied from class: AbstractWebComponent

Saves the component state

Parameters:

builder - a XMLStateSerializer object

howMuchState - how much state to save (EnumWebPersistableState)

setXMLStatus

public void setXMLStatus(int status)

Specified by:

setXMLStatus in interface AssociatedSchedulesBean

getXMLStatus

public int getXMLStatus()

Description copied from interface: WebComponent

This method returns the EnumRequestStatus status of the current Component.

Specified by:

getXMLStatus in interface WebComponent

Returns:

the EnumRequestStatus of the current page.

getProjectAssociatedSchedules

public WebAssociatedSchedules getProjectAssociatedSchedules()

Description copied from interface: AssociatedSchedulesBean

retrieve the associated schedules with project in the Preference page

Specified by:

getProjectAssociatedSchedules in interface AssociatedSchedulesBean

Returns:

WebAssociatedSchedules representing the associated schedule

getAssociatedSchedulesForObject

public WebAssociatedSchedules getAssociatedSchedulesForObject()

Description copied from interface: AssociatedSchedulesBean

retrieve the associated schedules with report or RWD

Specified by:

getAssociatedSchedulesForObject in interface AssociatedSchedulesBean

Returns:

WebAssociatedSchedules representing the associated schedule

getProjectLevelSchedules

public WebAssociatedSchedules getProjectLevelSchedules()

Description copied from interface: AssociatedSchedulesBean

retrieve the associated schedules with project in report or RWD option page

Specified by:

getProjectLevelSchedules in interface AssociatedSchedulesBean

Returns:

WebAssociatedSchedules representing the associated schedule

getISSTriger

public WebIServerSubscriptionTrigger getISSTriger(java.lang.String id)
                                           throws WebObjectsException,
                                                  java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

getDocument

public org.w3c.dom.Document getDocument()
                                 throws WebBeanException

Description copied from interface: WebBean

Returns a org.w3c.dom.Document parsed from the XML representation of this bean.

Specified by:

getDocument in interface WebBean

Returns:

the XML representation of this bean.

Throws:

WebBeanException - thrown if there is error when collecting data for this bean.

getErrorInfo

public WebBeanError getErrorInfo()

Description copied from interface: WebBean

Returns a WebBeanError object indicating processing error during the collectData method call. Null is returned if there is no error.

Specified by:

getErrorInfo in interface WebBean

Returns:

a WebBeanError object; null if there is no error.

setErrorInfo

protected void setErrorInfo(WebBeanError beanErr)

getSessionInfo

public WebSessionInfo getSessionInfo()

Description copied from interface: WebBean

Returns the WebSessionInfo instance from this bean. A WebSessionInfo object is where you can get or set the session ID to the intelligence server, user credentials and localization, etc.

Specified by:

getSessionInfo in interface WebBean

Returns:

a WebSessionInfo instance.

setSessionInfo

public void setSessionInfo(WebSessionInfo sessionInfo)
                    throws java.lang.IllegalArgumentException

Description copied from interface: WebBean

Sets a new WebSessionInfo instance on this bean. A WebSessionInfo object is where you can get or set the session ID to the intelligence server, user credentials and localization, etc.

Specified by:

setSessionInfo in interface WebBean

Parameters:

sessionInfo - a WebSessionInfo instance.

Throws:

java.lang.IllegalArgumentException

isStale

public boolean isStale()

Description copied from interface: WebBean

Returns a boolean value indicating whether the content of this bean is stale.

Specified by:

isStale in interface WebBean

Returns:

true if this bean is stale.

setStale

public void setStale(boolean stale)

Description copied from interface: WebBean

Sets a flag indicating whether this bean is stale or fresh.

Specified by:

setStale in interface WebBean

Parameters:

stale - true if this bean is stale.

reset

protected void reset()

invalidateAllTransformCaches

protected void invalidateAllTransformCaches()

generateOutput

public MarkupOutput generateOutput()

Description copied from interface: WebComponent

This is the generic method to ask the WebComponent to generate some output for the client. The type of output should be determined by the OutputFormat property (WebComponent.setOutputFormat(int)).

Specified by:

generateOutput in interface WebComponent

Returns:

a MarkupOutput object.

internalCollectData

protected void internalCollectData()
                            throws WebBeanException

This method internally calls the method collectData if the method collectData has not yet been called. Otherwise it does nothing.

Overrides:

internalCollectData in class AbstractTransformable

Throws:

WebBeanException - thrown if there is severe errors when collecting data

See Also:

AbstractTransformable.internalCollectData(boolean)

internalCollectData

protected void internalCollectData(boolean collectOnError)
                            throws WebBeanException

Description copied from class: AbstractTransformable

Overriding method should not only throw WebBeanException, but also sets error info if possible.

Overrides:

internalCollectData in class AbstractTransformable

Parameters:

collectOnError - will attempt to collect data even if object in in error.

Throws:

WebBeanException - thrown if there is severe errors when collecting data

internalCollectData

protected void internalCollectData(boolean collectOnError,
                                   boolean collectOnProcessing)
                            throws WebBeanException

Description copied from class: AbstractTransformable

Overriding method should not only throw WebBeanException, but also sets error info if possible.

Overrides:

internalCollectData in class AbstractTransformable

Parameters:

collectOnError - will attempt to collect data even if object in in error.

collectOnProcessing - will attempt to collect data even if object is in processing.

Throws:

WebBeanException - thrown if there is severe errors when collecting data

collectData

public void collectData()
                 throws WebBeanException

Description copied from class: AbstractWebComponent

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance.

Specified by:

collectData in interface WebComponent

Overrides:

collectData in class AbstractWebComponent

Throws:

WebBeanException - thrown if there is any exception

doCollectMinimalData

protected void doCollectMinimalData()
                             throws WebBeanException

Throws:

WebBeanException

collectMinimalData

public void collectMinimalData()
                        throws WebBeanException

Description copied from interface: WebComponent

This is similar to WebComponent.collectData() except data collected is minimal. This is essentially a check to ensure everything is ok, but that we don't need any data. After invoking this operation, see WebComponent.getXMLStatus() and WebBean.getErrorInfo() for details.

Specified by:

collectMinimalData in interface WebComponent

Overrides:

collectMinimalData in class AbstractWebComponent

Throws:

WebBeanException - thrown if an error occurs during this operation.

getDescriptor

public java.lang.String getDescriptor(int key)

getDescriptor

public java.lang.String getDescriptor(java.lang.String key)

isTransformSuitable

protected boolean isTransformSuitable(Transform t)

Description copied from class: AbstractTransformable

This method is called in the addTransform methods. It verifies that the passed transform is suitable for this object. Default implementation simply calls transform's supports method.

Overrides:

isTransformSuitable in class AbstractTransformable

checkBeanType

protected void checkBeanType(AttributesXt attrs,
                             java.lang.String expected)
                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.0.0

checkHowMuchState

protected void checkHowMuchState(AttributesXt attrs)
                          throws java.lang.IllegalArgumentException,
                                 SAXSupportException

Throws:

java.lang.IllegalArgumentException

SAXSupportException

Since:

MicroStrategy Web 8.0.0

newDefaultBeanContext

protected BeanContext newDefaultBeanContext()

Description copied from class: AbstractTransformable

This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.

Overrides:

newDefaultBeanContext in class AbstractTransformable

addTransform

protected TransformInstance addTransform(Transform transform,
                                         java.lang.String key)

Adds a transform to itself and all the child beans which support the transform and returns a TransformInstance of the last child bean it was added to.

Overrides:

addTransform in class AbstractTransformable

hasTransform

public boolean hasTransform()

Description copied from interface: Transformable

Returns a boolean value indicating whether there is a default TransformInstance object.

Specified by:

hasTransform in interface Transformable

Overrides:

hasTransform in class AbstractTransformable

Returns:

true if there is a default transform.

hasTransform

public boolean hasTransform(java.lang.String key)

Description copied from interface: Transformable

Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.

Specified by:

hasTransform in interface Transformable

Overrides:

hasTransform in class AbstractTransformable

Parameters:

key - the key of a Transform

Returns:

true if there is such a TransformInstance with the specified key.

getTransformInstance

public TransformInstance getTransformInstance(java.lang.String key)
                                       throws KeyDoesNotExistException

Description copied from interface: Transformable

Returns the TransformInstance object with the specified key.

Specified by:

getTransformInstance in interface Transformable

Overrides:

getTransformInstance in class AbstractTransformable

Parameters:

key - the key of a TransformInstance.

Returns:

the TransformInstance object with the specified key.

Throws:

KeyDoesNotExistException - thrown if the key is not found.

getTransformInstances

public java.util.Enumeration getTransformInstances()

Description copied from interface: Transformable

Retuns a java.util.Enumeration over all the TransformInstance objects.

Specified by:

getTransformInstances in interface Transformable

Overrides:

getTransformInstances in class AbstractTransformable

Returns:

a java.util.Enumeration over all the TransformInstance objects.

setWebEventHandler

public void setWebEventHandler(WebEventHandler handler)

Description copied from class: AbstractWebComponent

Associate with this component a WebEventHandler instance.

A WebComponent has one to one relationship with a WebEventHandler instance. This method first removes any existing handler associated with this component, and then sets the new one on it.

This method calls the method WebEventHandler.setWebComponent(com.microstrategy.web.beans.WebComponent). Therefore, the WebEventHandler implementator should be careful to avoid cyclic reference to each other between this component and the event handler.

Specified by:

setWebEventHandler in interface WebComponent

Overrides:

setWebEventHandler in class AbstractWebComponent

Parameters:

handler - the WebEventHandler instance to set.

See Also:

WebComponent.setWebEventHandler(com.microstrategy.web.beans.WebEventHandler)

newStyleRequestContext

protected StyleRequestContext newStyleRequestContext()

Overrides:

newStyleRequestContext in class AbstractWebComponent