public interface

WebObjectsPrompt

implements WebPrompt
com.microstrategy.web.objects.WebObjectsPrompt

Class Overview

This interface represents Objects prompt.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebFolder getAnswer()
Returns the current prompt answer.
abstract WebFolder getDefaultAnswer()
Returns the default prompt answer
abstract WebFolder getPreviousAnswer()
Returns the previous prompt answer
abstract WebSearch getSearchRestriction()
Returns a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
abstract WebFolder getSuggestedAnswers(boolean createIfNull)
Returns the collection of suggested answers.
abstract WebFolder getSuggestedAnswers()
Returns a folder object containing suggested answers or null.
abstract void removeSuggestedAnswers()
abstract WebFolder setAnswer(WebFolder answer)
Sets the current prompt answer.
abstract void setSearchRestriction(WebSearch search)
Sets a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPrompt
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebFolder getAnswer ()

Returns the current prompt answer. If there is no answer available, an empty WebFolder is returned, which can be used to build answer.

Returns
  • the current prompt answer

public abstract WebFolder getDefaultAnswer ()

Returns the default prompt answer

Returns
  • the default prompt answer

public abstract WebFolder getPreviousAnswer ()

Returns the previous prompt answer

Returns
  • the previous prompt answer

public abstract WebSearch getSearchRestriction ()

Returns a search object that shall be used to get a list of possible answers if the suggested answers list is empty.

Returns
  • a search object that shall be used to get a list of possible answers if the suggested answers list is empty.

public abstract WebFolder getSuggestedAnswers (boolean createIfNull)

Returns the collection of suggested answers. If createIfNull is passed as true, and there exists no collection, then an empty one will be created. If the prompt object refers to a prompt definition, rather than a prompt question, then the collection will be editable.

Parameters
createIfNull Whether to create a new empty collection if one is not found.
Returns
  • A WebFolder containing the suggested answers.

public abstract WebFolder getSuggestedAnswers ()

Returns a folder object containing suggested answers or null.

Returns
  • a folder object containing suggested answers or null.

public abstract void removeSuggestedAnswers ()

public abstract WebFolder setAnswer (WebFolder answer)

Sets the current prompt answer. Internally this method creates a new copy of the answer object and stores it as the current answer. (If the answer object is the same as the current answer no copy is created).

Parameters
answer a prompt answer
Returns
  • a current answer that is a newly created copy of the answer object.

public abstract void setSearchRestriction (WebSearch search)

Sets a search object that shall be used to get a list of possible answers if the suggested answers list is empty.

Parameters
search a search object that shall be used to get a list of possible answers if the suggested answers list is empty.