Package com.microstrategy.web.app.beans

Interface ObjectSelectionBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

public interface ObjectSelectionBean
extends AppComponent, RequestPersistable

The ObjectSelectionBean is a bean which supports the operation of selecting one or more objects in a general folder browsing structure. The ObjectSelectionBean is expected to have a FolderBean as a child in order to work properly. The ObjectSelectionBean will hold information about the current selections and the restrictions, and the FolderBean will be used to browse the available objects. Finally, it also provides accept/rollback functionality.

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	acceptChanges()	This method tells the bean to propagate the current selections back to their original source.
WebFolder	getCurrentSelections()	Returns the current selections of the bean.
FolderBean	getFolderBean()	Returns the FolderBean child of this bean, or null if one does not exist.
int	getSizeRestriction()	Returns the size restriction of the bean - i.e. the maximum number of answers that are allowed in the bean's context.
int[]	getTypeRestriction()	Returns the type restriction of the bean.
void	resetChanges()	This method tells the bean to discard any changes and to restore the bean back to the state it was in when it was last obtained.

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.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.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

Method Detail

getCurrentSelections

WebFolder getCurrentSelections()
                        throws WebAppException

Returns the current selections of the bean.

Returns:

A WebFolder representing the current selections of the bean.

Throws:

WebAppException

getSizeRestriction

int getSizeRestriction()

Returns the size restriction of the bean - i.e. the maximum number of answers that are allowed in the bean's context. If this is 0 or -1, then there is assumed to be no maximum.

Returns:

The size restriction of the bean.

getTypeRestriction

int[] getTypeRestriction()

Returns the type restriction of the bean. If only objects of a certain type are expected to be added to the bean, then this will contain those object types, from EnumDSSXMLObjectTypes. If there is no restriction, then this will be either null or empty.

Returns:

An int array of type restriction values. Each value will be from EnumDSSXMLObjectTypes.

getFolderBean

FolderBean getFolderBean()
                  throws WebAppException

Returns the FolderBean child of this bean, or null if one does not exist.

Returns:

The child FolderBean of this bean.

Throws:

WebAppException

acceptChanges

void acceptChanges()
            throws WebAppException

This method tells the bean to propagate the current selections back to their original source. Before this method is called, any changes made to the ObjectSelectionBean will not be reflected in the source location.

Throws:

WebAppException

resetChanges

void resetChanges()

This method tells the bean to discard any changes and to restore the bean back to the state it was in when it was last obtained.