public interface

ObjectSelectionBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.ObjectSelectionBean

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract void acceptChanges()
This method tells the bean to propagate the current selections back to their original source.
abstract WebFolder getCurrentSelections()
Returns the current selections of the bean.
abstract FolderBean getFolderBean()
Returns the FolderBean child of this bean, or null if one does not exist.
abstract int getSizeRestriction()
Returns the size restriction of the bean - i.e.
abstract int[] getTypeRestriction()
Returns the type restriction of the bean.
abstract 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.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
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 acceptChanges ()

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.

public abstract WebFolder getCurrentSelections ()

Returns the current selections of the bean.

Returns
  • A WebFolder representing the current selections of the bean.

public abstract FolderBean getFolderBean ()

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

Returns

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

public abstract 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

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