public interface

DerivedElementBean

implements ExpressionBean

com.microstrategy.web.beans.DerivedElementBean

Known Indirect Subclasses

DerivedElementBeanImpl

Class Overview

This bean represents a single Derived Element

Summary

Nested Classes
interface	DerivedElementBean.Host	Represents this bean's host

Constants
int	AVAILABLES_SOURCE_CONSTANT	Constant for available units source type
int	AVAILABLES_SOURCE_DERIVED_ELEMENTS	Constant for available units source type
int	AVAILABLES_SOURCE_ELEMENTS	Constant for available units source type

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract void	addToExclude(KeyedList elements, WebDerivedElement de)
abstract void	addToExclude(KeyedList excludeElements)
abstract WebElements	excludedElements() gets the current filter applied to the element source
abstract boolean	fromSearch() Indicates that source elements are obtained from search
abstract WebEvent	getAcceptListChangesEvent() Returns the Accept List Chavnges event
abstract WebAttribute	getAttribute() Returns the attribute elements belong to.
abstract int	getAvailablesSourceType() Returns the current available units source typw
abstract KeyedList	getDerovedElements()
abstract WebDerivedElement	getElement() Returns the derived element
abstract KeyedList	getExcludeElements()
abstract KeyedList	getExistingDerovedElements() Returns a collection of derived elements belonging to a given attribute.
abstract String	getMessageIDFromHost() Returns message id of the report/document instance.
abstract boolean	getShowAll() Returns value of the Show All flag.
abstract WebWorkingSet	getWorkingSet()
abstract boolean	isEditable() Returns whether the Expression bean is editable.
abstract boolean	isExpressionChanged() Returns whether or not the expression of this derived element is changed
abstract boolean	isHostModified() Returns whether or not host's derived elements is modified
abstract boolean	isIncFetching() Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editor
abstract boolean	isRA()
abstract void	reset() Clears current state
abstract void	setAvailablesSourceType(int value) Sets the current available source type.
abstract void	setHostModified(boolean isModified) Sets the modified status of host's derived elements
abstract void	setIncFetching(boolean isIncFetching) Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editor
abstract void	setShowAll(boolean value) Sets value of the Show All flag.
abstract void	startEditing() Initieats editing of the derive element

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.ExpressionBean

abstract void	acceptChange() Accepts the change that is currently being worked upon.
abstract boolean	canSelectElements(WebAttribute webAttribute) Returns true if Select Elements option can be used for the attribute
abstract WebAttributeForm	chooseDefaultForm(WebAttribute attr)
abstract WebObjectInfo	getActiveObject() Returns the active object, the object being qualified upon.
abstract int	getActiveOperatorNodeKey() Returns the current active operator node key.
abstract WebElementSource	getElementSource(WebAttribute att) Returns properly initialized element source for a given attribute.
abstract WebExpression	getExpression() Returns the internal expression object.
abstract int	getExpressionBeanType() Returns the expression bean type, from `EnumExpressionBeanType`.
abstract int	getExpressionEditMode() Returns the current expression edit mode of the bean, from `EnumExpressionEditMode`.
abstract Scrollable	getIncrementalFetch() Returns a `Scrollable` interface, which can be used to set the incremental fetch window for an attribute elements qualification.
abstract boolean	getMatchCase() Returns the match case flag, used in searching element browsing request.
abstract WebObjectInfo	getRHS() Returns the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
abstract String	getUserSearchPattern() Returns the search pattern that will be applied to any element browsing request.
abstract WebBeanError	getValidationErrorInfo() This can hold a validation error which came about from the validate call.
abstract boolean	isEditable() Returns whether the Expression bean is editable.
abstract boolean	isEditable(WebNode node) Returns whether the given node can be edited properly under the current context of the application.
abstract boolean	isModified() Returns whether this filter is modified from the filter object that it synchronizes with.
abstract void	populateObject(WebObjectInfo oi)
abstract void	resetChanges() Undoes all changes since the last synchronize call.
abstract void	setActiveOperatorNodeKey(int key, boolean isNew) Sets the current active operator node key.
abstract void	setContext(ExpressionBeanContext context) Sets the `ExpressionBeanContext`.
abstract void	setExpressionEditMode(int mode) Sets the current expression edit mode of the bean, from `EnumExpressionEditMode`.
abstract void	setIsEditable(boolean value) Sets whether the expression bean is editable.
abstract void	setMatchCase(boolean matchCase) Sets the match case flag, which determines whether the user search pattern must match case or not.
abstract void	setRHS(WebObjectInfo rhs) Set the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
abstract void	setUserSearchPattern(String pattern) Sets the search pattern that will be applied to any element browsing request.
abstract void	setValidationErrorInfo(WebBeanError err)
abstract boolean	shallSelectElements(WebAttribute webAttribute) This method is used to decide what Attribute subexpression to create in a given context.
abstract void	synchronize() Synchronizes any changes that have been made to this expression to the owner expression accessible on the WebReportInstance or WebPrompt object.
abstract void	undoChange() Undoes the change that is currently being worked upon.
abstract boolean	validate() Attempts to perform validation on the expression.
abstract boolean	validateOperands(WebNode node) Returns whether the given node and its children are valid.

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

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Constants

public static final int AVAILABLES_SOURCE_CONSTANT

Constant for available units source type

Constant Value: -1 (0xffffffff)

public static final int AVAILABLES_SOURCE_DERIVED_ELEMENTS

Constant for available units source type

Constant Value: 2 (0x00000002)

public static final int AVAILABLES_SOURCE_ELEMENTS

Constant for available units source type

Constant Value: 1 (0x00000001)

Public Methods

public abstract void addToExclude (KeyedList elements, WebDerivedElement de)

public abstract void addToExclude (KeyedList excludeElements)

public abstract WebElements excludedElements ()

gets the current filter applied to the element source

public abstract boolean fromSearch ()

Indicates that source elements are obtained from search

public abstract WebEvent getAcceptListChangesEvent ()

Returns the Accept List Chavnges event

Returns

WebEvent

public abstract WebAttribute getAttribute ()

Returns the attribute elements belong to.

Returns

the attribute elements belong to.

public abstract int getAvailablesSourceType ()

Returns the current available units source typw

Returns

the current available units source typw

public abstract KeyedList getDerovedElements ()

public abstract WebDerivedElement getElement ()

Returns the derived element

Returns

the derived element

public abstract KeyedList getExcludeElements ()

public abstract KeyedList getExistingDerovedElements ()

Returns a collection of derived elements belonging to a given attribute.

Returns

KeyedList

public abstract String getMessageIDFromHost ()

Returns message id of the report/document instance.

Returns

message id

Throws

WebBeanException

public abstract boolean getShowAll ()

Returns value of the Show All flag.

Returns

the Show All flag

public abstract WebWorkingSet getWorkingSet ()

Throws

WebBeanException
WebObjectsException

public abstract boolean isEditable ()

Returns whether the Expression bean is editable.

Returns

True if the bean is editable, false otherwise.

public abstract boolean isExpressionChanged ()

Returns whether or not the expression of this derived element is changed

Throws

WebBeanException
WebObjectsException

public abstract boolean isHostModified ()

Returns whether or not host's derived elements is modified

public abstract boolean isIncFetching ()

Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editor

Returns

isIncFetching flag

public abstract boolean isRA ()

public abstract void reset ()

Clears current state

public abstract void setAvailablesSourceType (int value)

Sets the current available source type.

Parameters

value	value

public abstract void setHostModified (boolean isModified)

Sets the modified status of host's derived elements

public abstract void setIncFetching (boolean isIncFetching)

Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editor

public abstract void setShowAll (boolean value)

Sets value of the Show All flag.

Parameters

value	value

public abstract void startEditing ()

Initieats editing of the derive element

Interfaces

Classes

Exceptions

DerivedElementBean

Class Overview

Summary

Constants

public static final int AVAILABLES_SOURCE_CONSTANT

public static final int AVAILABLES_SOURCE_DERIVED_ELEMENTS

public static final int AVAILABLES_SOURCE_ELEMENTS

Public Methods

public abstract void addToExclude (KeyedList elements, WebDerivedElement de)

public abstract void addToExclude (KeyedList excludeElements)

public abstract WebElements excludedElements ()

public abstract boolean fromSearch ()

public abstract WebEvent getAcceptListChangesEvent ()

Returns

public abstract WebAttribute getAttribute ()

Returns

public abstract int getAvailablesSourceType ()

Returns

public abstract KeyedList getDerovedElements ()

public abstract WebDerivedElement getElement ()

Returns

public abstract KeyedList getExcludeElements ()

public abstract KeyedList getExistingDerovedElements ()

Returns

public abstract String getMessageIDFromHost ()

Returns

Throws

public abstract boolean getShowAll ()

Returns

public abstract WebWorkingSet getWorkingSet ()

Throws

public abstract boolean isEditable ()

Returns

public abstract boolean isExpressionChanged ()

Throws

public abstract boolean isHostModified ()

public abstract boolean isIncFetching ()

Returns

public abstract boolean isRA ()

public abstract void reset ()

public abstract void setAvailablesSourceType (int value)

Parameters

public abstract void setHostModified (boolean isModified)

public abstract void setIncFetching (boolean isIncFetching)

public abstract void setShowAll (boolean value)

Parameters

public abstract void startEditing ()