Package com.microstrategy.web.beans
Interface ObjectPromptBean
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,PromptBean
,PromptObject
,RequestPersistable
,Transformable
,WebBean
,WebComponent
public interface ObjectPromptBean extends PromptBean
Interface of the Object Prompt Bean- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
-
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
addObject(WebObjectInfo objInfo)
Add an object to the answer collectionvoid
clearAnswer()
Clear the prompt answer.WebFolder
getAnswer()
Returns the answer of the ObjectPrompt asWebFolder
.FolderBean
getAvailableItemsAsFolder()
WebFolder
getHierarchicalFolder()
Returns the current folder for prompts that support hierarchical folder browsing.WebSearch
getSearchObject()
Returns the search object associated with the prompt.boolean
isHierarchicalBrowsingSupported()
Returns true if the prompt style supports hierarchical browsingvoid
removeObject(int key)
Remove an object from the answer based on the keyvoid
setHierarchicalFolder(java.lang.String folderId)
Change the hierarchical subfolder associated with the prompt.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.PromptBean
getAvailableItems, getSelectedItems, isXDAMDXPrompt
-
Methods inherited from interface com.microstrategy.web.beans.PromptObject
getDisplayHelper, getHighlightedObjects, getOriginalSearchRoot, getPromptPosition, getPromptsBean, getPromptsSource, getUserSearchPattern, getValidationInfo, getWebPrompt, hasAnswerChanged, setAnswerChanged, setUserSearchPattern, setValidationInfo
-
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
-
-
-
-
Method Detail
-
getAnswer
WebFolder getAnswer()
Returns the answer of the ObjectPrompt asWebFolder
.- Returns:
- the
WebFolder
collection.
-
clearAnswer
void clearAnswer()
Clear the prompt answer.
-
addObject
void addObject(WebObjectInfo objInfo)
Add an object to the answer collection- Parameters:
objInfo
- -WebObjectInfo
to add.
-
removeObject
void removeObject(int key)
Remove an object from the answer based on the key- Parameters:
key
- - key of the object to be removed.
-
getHierarchicalFolder
WebFolder getHierarchicalFolder()
Returns the current folder for prompts that support hierarchical folder browsing.- Returns:
- the current hierarchical folder if hierarchical browsing is supported, else returns null.
-
setHierarchicalFolder
void setHierarchicalFolder(java.lang.String folderId)
Change the hierarchical subfolder associated with the prompt. Used when the style uses hierarchical folder browsing.- Parameters:
folderId
- - the id of the folder to be set as the current folder.
-
getSearchObject
WebSearch getSearchObject()
Returns the search object associated with the prompt.- Returns:
WebSearch
associated with the prompt.
-
isHierarchicalBrowsingSupported
boolean isHierarchicalBrowsingSupported()
Returns true if the prompt style supports hierarchical browsing- Returns:
- true if hierarchical browsing is supported.
-
getAvailableItemsAsFolder
FolderBean getAvailableItemsAsFolder()
-
-