Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

DerivedElementsEditorBean

implements ReportFrameElement ViewBeanParserBean

com.microstrategy.web.app.beans.DerivedElementsEditorBean

Class Overview

This bean supports editing a collection of Derived Elements belonging to a given template attribute.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

Public Methods
abstract void	acceptElementChanges() Generate deltas for all changes in the current derived element
abstract WebDerivedElement	addElement(int type) Adds a new Derived Alement
abstract void	applyChanges() Applies accumulated changes
abstract void	cancellChanges()
abstract void	convertToLocalElements() Converts stand-alone derived elements to local derived elements.
abstract WebAttribute	getAttribute() Returns attribute Derived Elements belong to.
abstract DerivedElementsBrowserBean	getBrowserBean()
abstract WebDerivedElement	getCurrentElement() Returns current Derived Element
abstract DerivedElementBean	getCurrentElementBean() Returns a bean representing current element
abstract WebDerivedElements	getDerivedElements()
abstract KeyedList	getElementList() Returns Derived Elements collection
abstract AppComponent	getFormatEditor() Returns format editor bean that can be used to edit the current derived element formats
abstract String	getLinkedObjectName() Returns name of linked derived elements
abstract int	getSourceMode()
abstract String	getUnitId() Returns template unit ID
abstract WebBeanError	getValidationErrorInfo() Returns validation error info.
abstract boolean	hasElementChanged()
abstract void	importElements(String deId) Adds a reference to the stand alone derived element to template attribute.
abstract boolean	isEditable()
abstract boolean	isForSort()
abstract boolean	isModified() Returns whether or not current derived elements is modified
abstract int	move(String deId, int offset) Moves specified Derived Element by specified offset
abstract void	open(String attId) Opens the editor to edit derived elements of the specified template attribute
abstract WebDerivedElement	remove(String deId) Removes specified Derived Element
abstract void	removeAll() Removes all Derived Elements.
abstract void	saveElements(String name, String description, String folderId, boolean overwrite) Save template attribute's local derived elements as a stand alone object.
abstract void	setAttributeId(String value) Sets template unit ID
abstract void	setCurrentElement(String id) Sets the current Derived Element
abstract void	setForSort(boolean value)
abstract void	setForSortStr(String value)
abstract void	setModified(boolean isModified) Sets the modified status of current derived elements
abstract void	setValidationErrorInfo(WebBeanError err) Sets validation error info.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameElement

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
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	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From interface com.microstrategy.web.app.beans.ReportFrameElement

From interface com.microstrategy.web.app.beans.ViewBeanParserBean

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

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) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) 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(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
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(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) 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) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) 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.

Public Methods

public abstract void acceptElementChanges ()

Generate deltas for all changes in the current derived element

public abstract WebDerivedElement addElement (int type)

Adds a new Derived Alement

Parameters

type	element type

Returns

new element

Throws

	WebException
WebObjectsException
WebException

public abstract void applyChanges ()

Applies accumulated changes

Throws

	WebBeanException
WebObjectsException
WebBeanException

public abstract void cancellChanges ()

public abstract void convertToLocalElements ()

Converts stand-alone derived elements to local derived elements.

Throws

WebBeanException

public abstract WebAttribute getAttribute ()

Returns attribute Derived Elements belong to.

Returns

attribute Derived Elements belong to.

public abstract DerivedElementsBrowserBean getBrowserBean ()

public abstract WebDerivedElement getCurrentElement ()

Returns current Derived Element

Returns

current Derived Element

public abstract DerivedElementBean getCurrentElementBean ()

Returns a bean representing current element

Returns

a bean representing current element

public abstract WebDerivedElements getDerivedElements ()

public abstract KeyedList getElementList ()

Returns Derived Elements collection

Returns

Derived Elements collection

public abstract AppComponent getFormatEditor ()

Returns format editor bean that can be used to edit the current derived element formats

public abstract String getLinkedObjectName ()

Returns name of linked derived elements

Returns

the name of linked derived elements, or null if derived elements is not stand-alone.

public abstract int getSourceMode ()

public abstract String getUnitId ()

Returns template unit ID

Returns

template unit ID

public abstract WebBeanError getValidationErrorInfo ()

Returns validation error info.

Returns

validation error info.

public abstract boolean hasElementChanged ()

public abstract void importElements (String deId)

Adds a reference to the stand alone derived element to template attribute. If the template attribute had another stand alone or local derived elements all of them will be removed.

Parameters

deId	DSS ID of the stand alone derived element.

Throws

WebBeanException

public abstract boolean isEditable ()

public abstract boolean isForSort ()

public abstract boolean isModified ()

Returns whether or not current derived elements is modified

public abstract int move (String deId, int offset)

Moves specified Derived Element by specified offset

Parameters

deId	element ID
offset	offset

Returns

new element position

public abstract void open (String attId)

Opens the editor to edit derived elements of the specified template attribute

Parameters

attId	DSS ID of the template attribute

Throws

WebObjectsException
WebException
IllegalArgumentException

public abstract WebDerivedElement remove (String deId)

Removes specified Derived Element

Parameters

deId	element ID

Returns

removed element

public abstract void removeAll ()

Removes all Derived Elements.

Throws

WebBeanException

public abstract void saveElements (String name, String description, String folderId, boolean overwrite)

Save template attribute's local derived elements as a stand alone object. It also replaces local derived elements with the reference to the saved stand alone object.

Parameters

name	- name of saved object
description	- object description
folderId	- DSS ID of the folder where the object shall be saved
overwrite	- indicates whether the saave operation can overwrite existing object with the same name

Throws

WebBeanException

public abstract void setAttributeId (String value)

Sets template unit ID

Parameters

value	unit ID

public abstract void setCurrentElement (String id)

Sets the current Derived Element

Parameters

id	Derived Element ID

public abstract void setForSort (boolean value)

public abstract void setForSortStr (String value)

public abstract void setModified (boolean isModified)

Sets the modified status of current derived elements

public abstract void setValidationErrorInfo (WebBeanError err)

Sets validation error info.

Parameters

err	error info.

Interfaces

Classes

Exceptions

DerivedElementsEditorBean

Class Overview

Summary

Public Methods

public abstract void acceptElementChanges ()

public abstract WebDerivedElement addElement (int type)

Parameters

Returns

Throws

public abstract void applyChanges ()

Throws

public abstract void cancellChanges ()

public abstract void convertToLocalElements ()

Throws

public abstract WebAttribute getAttribute ()

Returns

public abstract DerivedElementsBrowserBean getBrowserBean ()

public abstract WebDerivedElement getCurrentElement ()

Returns

public abstract DerivedElementBean getCurrentElementBean ()

Returns

public abstract WebDerivedElements getDerivedElements ()

public abstract KeyedList getElementList ()

Returns

public abstract AppComponent getFormatEditor ()

public abstract String getLinkedObjectName ()

Returns

public abstract int getSourceMode ()

public abstract String getUnitId ()

Returns

public abstract WebBeanError getValidationErrorInfo ()

Returns

public abstract boolean hasElementChanged ()

public abstract void importElements (String deId)

Parameters

Throws

public abstract boolean isEditable ()

public abstract boolean isForSort ()

public abstract boolean isModified ()

public abstract int move (String deId, int offset)

Parameters

Returns

public abstract void open (String attId)

Parameters

Throws

public abstract WebDerivedElement remove (String deId)

Parameters

Returns

public abstract void removeAll ()

Throws

public abstract void saveElements (String name, String description, String folderId, boolean overwrite)

Parameters

Throws

public abstract void setAttributeId (String value)

Parameters

public abstract void setCurrentElement (String id)

Parameters

public abstract void setForSort (boolean value)

public abstract void setForSortStr (String value)

public abstract void setModified (boolean isModified)

public abstract void setValidationErrorInfo (WebBeanError err)

Parameters