public interface

ObjectPromptBean

implements PromptBean
com.microstrategy.web.beans.ObjectPromptBean

Class Overview

Interface of the Object Prompt Bean

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void addObject(WebObjectInfo objInfo)
Add an object to the answer collection
abstract void clearAnswer()
Clear the prompt answer.
abstract WebFolder getAnswer()
Returns the answer of the ObjectPrompt as WebFolder.
abstract FolderBean getAvailableItemsAsFolder()
abstract WebFolder getHierarchicalFolder()
Returns the current folder for prompts that support hierarchical folder browsing.
abstract WebSearch getSearchObject()
Returns the search object associated with the prompt.
abstract boolean isHierarchicalBrowsingSupported()
Returns true if the prompt style supports hierarchical browsing
abstract void removeObject(int key)
Remove an object from the answer based on the key
abstract void setHierarchicalFolder(String folderId)
Change the hierarchical subfolder associated with the prompt.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.PromptBean
From interface com.microstrategy.web.beans.PromptObject
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract void addObject (WebObjectInfo objInfo)

Add an object to the answer collection

Parameters
objInfo - WebObjectInfo to add.

public abstract void clearAnswer ()

Clear the prompt answer.

public abstract WebFolder getAnswer ()

Returns the answer of the ObjectPrompt as WebFolder.

Returns

public abstract FolderBean getAvailableItemsAsFolder ()

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

public abstract WebSearch getSearchObject ()

Returns the search object associated with the prompt.

Returns

public abstract boolean isHierarchicalBrowsingSupported ()

Returns true if the prompt style supports hierarchical browsing

Returns
  • true if hierarchical browsing is supported.

public abstract void removeObject (int key)

Remove an object from the answer based on the key

Parameters
key - key of the object to be removed.

public abstract void setHierarchicalFolder (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.