Package com.microstrategy.web.app.beans

Interface DerivedElementsEditorBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, ViewBeanParserBean, WebComponent

public interface DerivedElementsEditorBean
extends ViewBeanParserBean, ReportFrameElement

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

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

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

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

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

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

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

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

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, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

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, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler

Method Detail

getUnitId

java.lang.String getUnitId()

Returns template unit ID

Returns:

template unit ID

setAttributeId

void setAttributeId(java.lang.String value)

Sets template unit ID

Parameters:

value - unit ID

getElementList

KeyedList getElementList()

Returns Derived Elements collection

Returns:

Derived Elements collection

setCurrentElement

void setCurrentElement(java.lang.String id)

Sets the current Derived Element

Parameters:

id - Derived Element ID

getCurrentElement

WebDerivedElement getCurrentElement()

Returns current Derived Element

Returns:

current Derived Element

getAttribute

WebAttribute getAttribute()

Returns attribute Derived Elements belong to.

Returns:

attribute Derived Elements belong to.

addElement

WebDerivedElement addElement(int type)
                      throws WebException,
                             WebObjectsException

Adds a new Derived Alement

Parameters:

type - element type

Returns:

new element

Throws:

WebException

WebObjectsException

applyChanges

void applyChanges()
           throws WebBeanException,
                  WebObjectsException

Applies accumulated changes

Throws:

WebBeanException

WebObjectsException

getCurrentElementBean

DerivedElementBean getCurrentElementBean()

Returns a bean representing current element

Returns:

a bean representing current element

move

int move(java.lang.String deId,
         int offset)

Moves specified Derived Element by specified offset

Parameters:

deId - element ID

offset - offset

Returns:

new element position

remove

WebDerivedElement remove(java.lang.String deId)

Removes specified Derived Element

Parameters:

deId - element ID

Returns:

removed element

removeAll

void removeAll()
        throws WebBeanException

Removes all Derived Elements.

Throws:

WebBeanException

getValidationErrorInfo

WebBeanError getValidationErrorInfo()

Returns validation error info.

Returns:

validation error info.

setValidationErrorInfo

void setValidationErrorInfo(WebBeanError err)

Sets validation error info.

Parameters:

err - error info.

saveElements

void saveElements(java.lang.String name,
                  java.lang.String description,
                  java.lang.String folderId,
                  boolean overwrite)
           throws WebBeanException

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

importElements

void importElements(java.lang.String deId)
             throws WebBeanException

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

convertToLocalElements

void convertToLocalElements()
                     throws WebBeanException

Converts stand-alone derived elements to local derived elements.

Throws:

WebBeanException

open

void open(java.lang.String attId)
   throws WebException

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

Parameters:

attId - DSS ID of the template attribute

Throws:

WebObjectsException

WebException

java.lang.IllegalArgumentException

getFormatEditor

AppComponent getFormatEditor()

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

acceptElementChanges

void acceptElementChanges()

Generate deltas for all changes in the current derived element

isEditable

boolean isEditable()

setForSort

void setForSort(boolean value)

setForSortStr

void setForSortStr(java.lang.String value)

isForSort

boolean isForSort()

getBrowserBean

DerivedElementsBrowserBean getBrowserBean()

hasElementChanged

boolean hasElementChanged()

getDerivedElements

WebDerivedElements getDerivedElements()

cancellChanges

void cancellChanges()

isModified

boolean isModified()

Returns whether or not current derived elements is modified

setModified

void setModified(boolean isModified)

Sets the modified status of current derived elements

getLinkedObjectName

java.lang.String getLinkedObjectName()

Returns name of linked derived elements

Returns:

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

getSourceMode

int getSourceMode()