Package com.microstrategy.web.beans
Interface DerivedElementBean
-
- All Superinterfaces:
EnumWebPersistableState
,ExpressionBean
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
- All Known Implementing Classes:
DerivedElementBeanImpl
public interface DerivedElementBean extends ExpressionBean
This bean represents a single Derived Element- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
DerivedElementBean.Host
Represents this bean's host
-
Field Summary
Fields Modifier and Type Field Description static int
AVAILABLES_SOURCE_CONSTANT
Constant for available units source typestatic int
AVAILABLES_SOURCE_DERIVED_ELEMENTS
Constant for available units source typestatic int
AVAILABLES_SOURCE_ELEMENTS
Constant for available units source type-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addToExclude(KeyedList excludeElements)
void
addToExclude(KeyedList elements, WebDerivedElement de)
WebElements
excludedElements()
gets the current filter applied to the element sourceboolean
fromSearch()
Indicates that source elements are obtained from searchWebEvent
getAcceptListChangesEvent()
Returns the Accept List Chavnges eventWebAttribute
getAttribute()
Returns the attribute elements belong to.int
getAvailablesSourceType()
Returns the current available units source typwKeyedList
getDerovedElements()
WebDerivedElement
getElement()
Returns the derived elementKeyedList
getExcludeElements()
KeyedList
getExistingDerovedElements()
Returns a collection of derived elements belonging to a given attribute.java.lang.String
getMessageIDFromHost()
Returns message id of the report/document instance.boolean
getShowAll()
Returns value of the Show All flag.WebWorkingSet
getWorkingSet()
boolean
isEditable()
Returns whether the Expression bean is editable.boolean
isExpressionChanged()
Returns whether or not the expression of this derived element is changedboolean
isHostModified()
Returns whether or not host's derived elements is modifiedboolean
isIncFetching()
Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editorboolean
isRA()
void
reset()
Clears current statevoid
setAvailablesSourceType(int value)
Sets the current available source type.void
setHostModified(boolean isModified)
Sets the modified status of host's derived elementsvoid
setIncFetching(boolean isIncFetching)
Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editorvoid
setShowAll(boolean value)
Sets value of the Show All flag.void
startEditing()
Initieats editing of the derive element-
Methods inherited from interface com.microstrategy.web.beans.ExpressionBean
acceptChange, canSelectElements, chooseDefaultForm, getActiveObject, getActiveOperatorNodeKey, getElementSource, getExpression, getExpressionBeanType, getExpressionEditMode, getIncrementalFetch, getMatchCase, getRHS, getUserSearchPattern, getValidationErrorInfo, isEditable, isModified, populateObject, resetChanges, setActiveOperatorNodeKey, setContext, setExpressionEditMode, setIsEditable, setMatchCase, setRHS, setUserSearchPattern, setValidationErrorInfo, shallSelectElements, synchronize, undoChange, validate, validateOperands
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
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.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale
-
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, getTargetBean, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Field Detail
-
AVAILABLES_SOURCE_ELEMENTS
static final int AVAILABLES_SOURCE_ELEMENTS
Constant for available units source type- See Also:
- Constant Field Values
-
AVAILABLES_SOURCE_DERIVED_ELEMENTS
static final int AVAILABLES_SOURCE_DERIVED_ELEMENTS
Constant for available units source type- See Also:
- Constant Field Values
-
AVAILABLES_SOURCE_CONSTANT
static final int AVAILABLES_SOURCE_CONSTANT
Constant for available units source type- See Also:
- Constant Field Values
-
-
Method Detail
-
getElement
WebDerivedElement getElement()
Returns the derived element- Returns:
- the derived element
-
getAttribute
WebAttribute getAttribute()
Returns the attribute elements belong to.- Returns:
- the attribute elements belong to.
-
reset
void reset()
Clears current state
-
getAcceptListChangesEvent
WebEvent getAcceptListChangesEvent()
Returns the Accept List Chavnges event- Returns:
- WebEvent
-
startEditing
void startEditing()
Initieats editing of the derive element
-
getShowAll
boolean getShowAll()
Returns value of the Show All flag.- Returns:
- the Show All flag
-
setShowAll
void setShowAll(boolean value)
Sets value of the Show All flag.- Parameters:
value
- value
-
getAvailablesSourceType
int getAvailablesSourceType()
Returns the current available units source typw- Returns:
- the current available units source typw
-
setAvailablesSourceType
void setAvailablesSourceType(int value)
Sets the current available source type.- Parameters:
value
- value
-
getExistingDerovedElements
KeyedList getExistingDerovedElements()
Returns a collection of derived elements belonging to a given attribute.- Returns:
- KeyedList
-
getDerovedElements
KeyedList getDerovedElements()
-
isEditable
boolean isEditable()
Description copied from interface:ExpressionBean
Returns whether the Expression bean is editable.- Specified by:
isEditable
in interfaceExpressionBean
- Returns:
- True if the bean is editable, false otherwise.
-
getWorkingSet
WebWorkingSet getWorkingSet() throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
isIncFetching
boolean isIncFetching()
Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editor- Returns:
- isIncFetching flag
-
setIncFetching
void setIncFetching(boolean isIncFetching)
Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editor- Parameters:
isIncFetching
-
-
isExpressionChanged
boolean isExpressionChanged() throws WebObjectsException, WebBeanException
Returns whether or not the expression of this derived element is changed- Throws:
WebObjectsException
WebBeanException
-
isHostModified
boolean isHostModified()
Returns whether or not host's derived elements is modified
-
setHostModified
void setHostModified(boolean isModified)
Sets the modified status of host's derived elements
-
addToExclude
void addToExclude(KeyedList elements, WebDerivedElement de)
-
addToExclude
void addToExclude(KeyedList excludeElements)
-
isRA
boolean isRA()
-
getExcludeElements
KeyedList getExcludeElements()
-
getMessageIDFromHost
java.lang.String getMessageIDFromHost() throws WebBeanException
Returns message id of the report/document instance.- Returns:
- message id
- Throws:
WebBeanException
-
fromSearch
boolean fromSearch()
Indicates that source elements are obtained from search- Returns:
-
excludedElements
WebElements excludedElements()
gets the current filter applied to the element source
-
-