Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp()
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPrompt

abstract void	answerPrompt() Submits prompt answers to the I-Server.
abstract void	buildShortAnswerXML(WebXMLBuilder builder)
abstract String	getAnswerXML(boolean encode) Returns the XML representation of prompt answer.
abstract String	getAnswerXML() Returns the XML representation of prompt answer.
abstract String	getAnswerXML(boolean shortFormat, boolean encode, boolean includeClosed) Returns an XML string representing the prompt answer.
abstract int	getBrowsableDataSourceFlags() Returns the XDA flags `EnumDSSXMLExternalSourceFlags` of the data source for browsing.
abstract int	getDSSPromptType()
abstract WebDisplayHelper	getDisplayHelper() Returns a display helper object that can be used to build prompt display XML.
abstract WebDisplayHelper	getDisplayHelper(boolean populateDisplayUnits) Returns a display helper object that can be used to build prompt display XML.
abstract WebProperties	getDisplayProperties() Returns prompt display properties or null.
abstract String	getKey() Returns a key to uniquely identify a `WebPrompt`.
abstract String	getMax() Returns value of prompt miximum property or null.
abstract String	getMeaning() Returns prompt meaning or null
abstract boolean	getMerge() ????
abstract String	getMessageId()
abstract String	getMin() Returns value of prompt minimum property or null.
abstract int	getPIN() Returns prompt's PIN assigned by the I-Server that uniquely identifies this prompt inside prompts collection.
abstract WebPromptLocation	getPrimaryLocation()
abstract int	getPromptType() Returns prompt type
abstract int	getReuse() Returns prompt reuse mode.
abstract String	getShortAnswerXML() Returns the XML representation of prompt answer in the format used by the Narrowcast server.
abstract String	getShortAnswerXML(boolean encode) Returns the XML representation of prompt answer in the format used by the Narrowcast server.
abstract String	getShortPa(boolean includeClosed)
abstract String	getShortPa()
abstract String	getTitle() Returns prompt title or null.
abstract WebUserAnswers	getUserAnswers() Returns a collection of user prompt answers.
abstract int[]	getXDATypes() Returns all XDA types associated with this prompt.
abstract boolean	hasAnswer() A prompt contains a collections of answers (previous/default/current).
abstract boolean	hasDefaultAnswer() A prompt contains a collections of answers (previous/default/current).
abstract boolean	hasOriginalAnswer() Returns true if original prompt XML contained current answer, false otherwise.
abstract boolean	hasPreviousAnswer() A prompt contains a collections of answers (previous/default/current).
abstract boolean	isAnswerEmpty() Returns true if the current prompt answer is null or the answer collection is empty (For example, in Elements collection is empty in case of an element prompt).
abstract boolean	isCanceled() Returns true if the prompt is canceled, false otherwise
abstract boolean	isClosed() Returns true if the prompt is closed, false otherwise.
abstract boolean	isRequired() Returns true if this prompt is required, false otherwise
abstract boolean	isUsed() Returns true if the prompt is used, false otherwise
abstract void	populateAnswer(String answerXML) Populate the current answer from the XML.
abstract void	resetAnswer() Resets the current answer to be either the previous answer or the default answer.
abstract void	setCanceled() Sets prompt closed flag.
abstract void	setClosed(boolean closed) Sets prompt closed flag.
abstract void	setMax(String max) Sets the maximum property of the prompt to the new value.
abstract void	setMeaning(String meaning) Sets the meaning of the prompt definition.
abstract void	setMin(String min) Sets the minimum property of the prompt to the new value.
abstract void	setRequired(boolean isRequired) Sets the required flag on the prompt.
abstract void	setReuse(int reuse) Sets the prompt reuse mode for a prompt definition.
abstract void	setTitle(String title) Sets the title of the prompt definition.
abstract void	validate() Validates whether the prompt passes the maximum and minimum limits (normally are limits on count of answers), and required validation requirements.

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.

Interfaces

Classes

Enums

Exceptions

WebObjectsPrompt

Class Overview

Summary

Public Methods

public abstract WebFolder getAnswer ()

Returns

public abstract WebFolder getDefaultAnswer ()

Returns

public abstract WebFolder getPreviousAnswer ()

Returns

public abstract WebSearch getSearchRestriction ()

Returns

public abstract WebFolder getSuggestedAnswers (boolean createIfNull)

Parameters

Returns

public abstract WebFolder getSuggestedAnswers ()

Returns

public abstract void removeSuggestedAnswers ()

public abstract WebFolder setAnswer (WebFolder answer)

Parameters

Returns

public abstract void setSearchRestriction (WebSearch search)

Parameters