Package com.microstrategy.web.objects
Interface WebElementsPrompt
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPrompt
,WebPromptSite
public interface WebElementsPrompt extends WebPrompt
This interface represents Elements 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 WebElements
getAnswer()
Returns the current prompt answer.int
getBlockBegin()
Returns the current blockBegin setting, which is used for incremental fetch of attribute elements.int
getBlockCount()
Returns the current blockCount setting, which is used for incremental fetch of elements.WebElements
getDefaultAnswer()
Returns the default prompt answerWebFilter
getDefinitionFilter()
Returns the filter restriction that is used for building the available answers restriction, absent any changes made as a result of user-entered searches.WebFilter
getFilterRestriction()
Returns the filter restriction for building available answers collection or null.WebAttribute
getOrigin()
Returns a source attribute for the prompt.WebElements
getPreviousAnswer()
Returns the previous prompt answerWebElements
getSuggestedAnswers()
Returns the collection of suggested answer elements or null if no suggested answers are defined.WebElements
getSuggestedAnswers(boolean createIfNull)
Returns a collection of suggested answer elements.WebElements
setAnswer(WebElements answer)
Sets the current prompt answer.void
setBlockBegin(int val)
Sets the blockBegin setting, which is used for incremental fetch of elements.void
setBlockCount(int val)
Sets the blockCount setting, which is used for incremental fetch of elements.void
setDefinitionFilter(WebFilter filter)
Sets the filter restriction used for building the available answers restriction, absent any changes made as a result of user-entered searches.void
setFilterRestriction(WebFilter filter)
Sets the filter restriction for building available answers collection (seeWebDisplayHelper.getAvailableDisplayUnits()
).void
setOrigin(WebAttribute attr)
Sets the source attribute for the prompt.-
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
WebElements getAnswer()
Returns the current prompt answer. If there is no answer available, an emptyWebElements
is returned, which can be used to build answer.- Returns:
- the current prompt answer
-
setAnswer
WebElements setAnswer(WebElements 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
WebElements getDefaultAnswer()
Returns the default prompt answer- Returns:
- the default prompt answer
-
getPreviousAnswer
WebElements getPreviousAnswer()
Returns the previous prompt answer- Returns:
- the previous prompt answer
-
getOrigin
WebAttribute getOrigin()
Returns a source attribute for the prompt.- Returns:
- a source attribute for the prompt.
-
setOrigin
void setOrigin(WebAttribute attr)
Sets the source attribute for the prompt.- Parameters:
attr
- The source attribute to be used.- Since:
- MicroStrategy Web 9.0.0
-
getSuggestedAnswers
WebElements getSuggestedAnswers()
Returns the collection of suggested answer elements or null if no suggested answers are defined. This list will be used in building available answers collection (seeWebDisplayHelper.getAvailableDisplayUnits()
).- Returns:
- A collection of suggested answer elements or null
-
getSuggestedAnswers
WebElements getSuggestedAnswers(boolean createIfNull)
Returns a collection of suggested answer elements. If createIfNull is true, then a new collection will be created if one does not already exists.- Parameters:
createIfNull
- Whether to create if null.- Returns:
- A
WebElements
collection. - Since:
- MicroStrategy Web 9.0.0
-
getFilterRestriction
WebFilter getFilterRestriction()
Returns the filter restriction for building available answers collection or null.- Returns:
- the filter restriction object or null.
- See Also:
WebDisplayHelper.getAvailableDisplayUnits()
-
setFilterRestriction
void setFilterRestriction(WebFilter filter)
Sets the filter restriction for building available answers collection (seeWebDisplayHelper.getAvailableDisplayUnits()
). Note that this only affects the temporary filter restriction - i.e. the one used immediately for retrieving elements. If editing a prompt definition, then setFilterRestriction will set the filter expression to be used as the filter in the prompt definition.- Parameters:
filter
- the filter restriction object or null.
-
getDefinitionFilter
WebFilter getDefinitionFilter()
Returns the filter restriction that is used for building the available answers restriction, absent any changes made as a result of user-entered searches.- Returns:
- A
WebFilter
object representing the filter defined on the prompt. - Since:
- MicroStrategy Web 9.0.0
-
setDefinitionFilter
void setDefinitionFilter(WebFilter filter) throws WebObjectsException
Sets the filter restriction used for building the available answers restriction, absent any changes made as a result of user-entered searches. Note that calling this method with null as the argument will cause the filter to be cleared.- Parameters:
filter
- TheWebFilter
that is to be used as the filter restriction on the definition.- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setBlockBegin
void setBlockBegin(int val)
Sets the blockBegin setting, which is used for incremental fetch of elements. This value tells the index of the first element in the collection to be retrieved. This value is usually used in conjunction withblockCount
.- Parameters:
val
- The blockBegin setting to be used upon populating the elements collection from the Intelligence Server.
-
getBlockBegin
int getBlockBegin()
Returns the current blockBegin setting, which is used for incremental fetch of attribute elements. This value tells the index of the first element in the collection to be retrieved. This value is usually used in conjunction withblockCount
.- Returns:
- The current blockBegin setting.
-
setBlockCount
void setBlockCount(int val)
Sets the blockCount setting, which is used for incremental fetch of elements. This value tells the number of elements to be retrieved. This value is usually used in conjunction withblockBegin
.- Parameters:
val
- The blockCount setting to be used upon populating the collection from the Intelligence Server.
-
getBlockCount
int getBlockCount()
Returns the current blockCount setting, which is used for incremental fetch of elements. This value tells the number of objects to be retrieved. This value is usually used in conjunction withblockBegin
.- Returns:
- The current blockCount setting.
-
-