public class

AssociatedSchedulesBeanImpl

extends AbstractWebComponent
implements AssociatedSchedulesBean RequestPersistable WebBean
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.beans.AbstractTransformable
       ↳ com.microstrategy.web.beans.AbstractWebComponent
         ↳ com.microstrategy.web.beans.AssociatedSchedulesBeanImpl

Summary

Constants
String ATTRIBUTE_BEAN_HEADER
String ATT_BEAN_TYPE
String ATT_HOW_MUCH_STATE
String DATA_EXPLORER_BEAN_HEADER
String DELIMITOR
String DOCUMENT_BEAN_HEADER
String EXPRESSION_BEAN_HEADER
String FILTER_BEAN_HEADER
String FOLDER_BEAN_HEADER
String INBOX_BEAN_HEADER
String PERFORMANCE_MONITOR_BEAN_HEADER
String PROMPTDEF_BEAN_HEADER
String PROMPTS_BEAN_HEADER
String REPORT_BEAN_HEADER
String RW_BEAN_HEADER
String SEPARATOR
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Fields
protected boolean _hasCollectedData A flag indicating that the XML request to collect data has been executed
protected int _status
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
AssociatedSchedulesBeanImpl()
Public Methods
void collectData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void collectMinimalData()
This is similar to collectData() except data collected is minimal.
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
String getDescriptor(int key)
String getDescriptor(String key)
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(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.
TransformInstance getTransformInstance(String key)
Returns the TransformInstance object with the specified key.
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(String key)
Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.
boolean isStale()
Returns a boolean value indicating whether the content of this bean is stale.
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)
Protected Methods
TransformInstance addTransform(Transform transform, 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.
void checkBeanType(AttributesXt attrs, String expected)
void checkHowMuchState(AttributesXt attrs)
void doCollectData()
Override this method in sub classes to implement the collectData method.
void doCollectMinimalData()
void doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler getStateHandler()
void internalCollectData(boolean collectOnError, boolean collectOnProcessing)
Overriding method should not only throw WebBeanException, but also sets error info if possible.
void internalCollectData(boolean collectOnError)
Overriding method should not only throw WebBeanException, but also sets error info if possible.
void internalCollectData()
This method internally calls the method collectData if the method collectData has not yet been called.
void invalidateAllTransformCaches()
boolean isTransformSuitable(Transform t)
This method is called in the addTransform methods.
BeanContext newDefaultBeanContext()
This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
WebEventHandler newDefaultEventHandler()
StyleRequestContext newStyleRequestContext()
void reset()
void saveXMLState(XMLStateSerializer builder, int howMuchState)
Saves the component state
void setErrorInfo(WebBeanError beanErr)
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.AssociatedSchedulesBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Constants

protected static final String ATTRIBUTE_BEAN_HEADER

Constant Value: "attb"

protected static final String ATT_BEAN_TYPE

Constant Value: "bt"

protected static final String ATT_HOW_MUCH_STATE

Constant Value: "hms"

protected static final String DATA_EXPLORER_BEAN_HEADER

Constant Value: "deb"

protected static final String DELIMITOR

Constant Value: ";"

protected static final String DOCUMENT_BEAN_HEADER

Constant Value: "db"

protected static final String EXPRESSION_BEAN_HEADER

Constant Value: "eb"

protected static final String FILTER_BEAN_HEADER

Constant Value: "ftb"

protected static final String FOLDER_BEAN_HEADER

Constant Value: "fb"

protected static final String INBOX_BEAN_HEADER

Constant Value: "ib"

protected static final String PERFORMANCE_MONITOR_BEAN_HEADER

Constant Value: "pmb"

protected static final String PROMPTDEF_BEAN_HEADER

Constant Value: "pdb"

protected static final String PROMPTS_BEAN_HEADER

Constant Value: "pb"

protected static final String REPORT_BEAN_HEADER

Constant Value: "rb"

protected static final String RW_BEAN_HEADER

Constant Value: "rwb"

protected static final String SEPARATOR

Constant Value: ":"

Fields

protected boolean _hasCollectedData

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

protected int _status

Public Constructors

public AssociatedSchedulesBeanImpl ()

Public Methods

public void collectData ()

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.

Throws
WebBeanException

public void collectMinimalData ()

This is similar to 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 getXMLStatus() and getErrorInfo() for details.

Throws
WebBeanException

public MarkupOutput generateOutput ()

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 (setOutputFormat(int)).

Returns

public WebAssociatedSchedules getAssociatedSchedulesForObject ()

retrieve the associated schedules with report or RWD

Returns
  • WebAssociatedSchedules representing the associated schedule

public String getDescriptor (int key)

public String getDescriptor (String key)

public Document getDocument ()

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

Returns
  • the XML representation of this bean.
Throws
WebBeanException

public WebBeanError getErrorInfo ()

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

Returns
  • a WebBeanError object; null if there is no error.

public WebIServerSubscriptionTrigger getISSTriger (String id)

Throws
IllegalArgumentException
WebObjectsException

public WebAssociatedSchedules getProjectAssociatedSchedules ()

retrieve the associated schedules with project in the Preference page

Returns
  • WebAssociatedSchedules representing the associated schedule

public WebAssociatedSchedules getProjectLevelSchedules ()

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

Returns
  • WebAssociatedSchedules representing the associated schedule

public WebSessionInfo getSessionInfo ()

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.

Returns
  • a WebSessionInfo instance.

public TransformInstance getTransformInstance (String key)

Returns the TransformInstance object with the specified key.

Parameters
key the key of a TransformInstance.
Returns
  • the TransformInstance object with the specified key.
Throws
KeyDoesNotExistException

public Enumeration getTransformInstances ()

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

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

public int getType ()

Returns the transformable type as in EnumWebTransformableType.

Returns
  • the transformable type.

public int getXMLStatus ()

This method returns the EnumRequestStatus status of the current Component.

Returns

public boolean hasTransform ()

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

Returns
  • true if there is a default transform.

public boolean hasTransform (String key)

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

Parameters
key the key of a Transform
Returns
  • true if there is such a TransformInstance with the specified key.

public boolean isStale ()

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

Returns
  • true if this bean is stale.

public void setSessionInfo (WebSessionInfo sessionInfo)

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.

Parameters
sessionInfo a WebSessionInfo instance.
Throws
IllegalArgumentException

public void setStale (boolean stale)

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

Parameters
stale true if this bean is stale.

public void setWebEventHandler (WebEventHandler handler)

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 setWebComponent(WebComponent). Therefore, the WebEventHandler implementator should be careful to avoid cyclic reference to each other between this component and the event handler.

Parameters
handler the WebEventHandler instance to set.
See Also

public void setXMLStatus (int status)

Protected Methods

protected TransformInstance addTransform (Transform transform, 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, String expected)

Throws
IllegalArgumentException

protected void checkHowMuchState (AttributesXt attrs)

Throws
IllegalArgumentException
SAXSupportException

protected void doCollectData ()

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

Throws
WebBeanException

protected void doCollectMinimalData ()

Throws
WebBeanException

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

protected AbstractHandler getStateHandler ()

protected void internalCollectData (boolean collectOnError, boolean collectOnProcessing)

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

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

protected void internalCollectData (boolean collectOnError)

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

Parameters
collectOnError will attempt to collect data even if object in in error.
Throws
WebBeanException

protected void internalCollectData ()

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

Throws
WebBeanException

protected void invalidateAllTransformCaches ()

protected boolean isTransformSuitable (Transform t)

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.

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

Parameters
builder a XMLStateSerializer object
howMuchState how much state to save (EnumWebPersistableState)

protected void setErrorInfo (WebBeanError beanErr)