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
From interface com.microstrategy.web.app.beans.FrameElement
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

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.

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.

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.

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

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.