Package com.microstrategy.web.objects
Interface WebObjectsPrompt
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPrompt
,WebPromptSite
public interface WebObjectsPrompt extends WebPrompt
This interface represents Objects prompt.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 WebFolder
getAnswer()
Returns the current prompt answer.WebFolder
getDefaultAnswer()
Returns the default prompt answerWebFolder
getPreviousAnswer()
Returns the previous prompt answerWebSearch
getSearchRestriction()
Returns a search object that shall be used to get a list of possible answers if the suggested answers list is empty.WebFolder
getSuggestedAnswers()
Returns a folder object containing suggested answers or null.WebFolder
getSuggestedAnswers(boolean createIfNull)
Returns the collection of suggested answers.void
removeSuggestedAnswers()
WebFolder
setAnswer(WebFolder answer)
Sets the current prompt answer.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.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPrompt
answerPrompt, buildShortAnswerXML, getAnswerXML, getAnswerXML, getAnswerXML, getBrowsableDataSourceFlags, getDisplayHelper, getDisplayHelper, getDisplayProperties, getDSSPromptType, getKey, getMax, getMeaning, getMerge, getMessageId, getMin, getPIN, getPrimaryLocation, getPromptType, getReuse, getShortAnswerXML, getShortAnswerXML, getShortPa, getShortPa, getTitle, getUserAnswers, getXDATypes, hasAnswer, hasDefaultAnswer, hasOriginalAnswer, hasPreviousAnswer, isAnswerEmpty, isCanceled, isClosed, isRequired, isUsed, populateAnswer, resetAnswer, resetToDefault, setCanceled, setClosed, setMax, setMeaning, setMin, setRequired, setReuse, setTitle, validate
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getAnswer
WebFolder getAnswer()
Returns the current prompt answer. If there is no answer available, an emptyWebFolder
is returned, which can be used to build answer.- Returns:
- the current prompt answer
-
setAnswer
WebFolder setAnswer(WebFolder answer)
Sets the current prompt answer. Internally this method creates a new copy of theanswer
object and stores it as the current answer. (If theanswer
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.
-
getDefaultAnswer
WebFolder getDefaultAnswer()
Returns the default prompt answer- Returns:
- the default prompt answer
-
getPreviousAnswer
WebFolder getPreviousAnswer()
Returns the previous prompt answer- Returns:
- the previous prompt answer
-
getSuggestedAnswers
WebFolder getSuggestedAnswers()
Returns a folder object containing suggested answers or null.- Returns:
- a folder object containing suggested answers or null.
-
getSuggestedAnswers
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. - Since:
- MicroStrategy Web 9.0.0
-
getSearchRestriction
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.
-
setSearchRestriction
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.
-
removeSuggestedAnswers
void removeSuggestedAnswers()
-
-