Package com.microstrategy.web.objects
Interface WebUserAnswers
-
public interface WebUserAnswers
TheWebUserAnswers
interface holds a collection ofWebPromptAnswer
. It comes from executing a prompted report or document.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
delete(WebPromptAnswer promptAnswer)
Deletes a prompt answer from the collection and also removes it from metadata.WebPromptAnswer
get(int index)
Returns the prompt answer object at the specified position.java.util.Iterator
getAnswers()
Returns an iterator over the collection of prompt answer objects.WebPromptAnswer
getDefaultAnswer()
Returns the default prompt answer if there is any.WebPromptAnswer
newPromptAnswer()
Creates a prompt answer object but has not yet been persisted in the metadata.void
save(WebPromptAnswer promptAnswer)
Saves a prompt answer object to the collection as well as in the metadata.int
size()
Returns the number of prompt answer objects in the collection.
-
-
-
Method Detail
-
get
WebPromptAnswer get(int index)
Returns the prompt answer object at the specified position.- Parameters:
index
- the position of a prompt answer.- Returns:
- the prompt answer object.
-
size
int size()
Returns the number of prompt answer objects in the collection.- Returns:
- the number of prompt answer objects in the collection.
-
getAnswers
java.util.Iterator getAnswers()
Returns an iterator over the collection of prompt answer objects.- Returns:
- an iterator over the collection of prompt answer objects.
-
getDefaultAnswer
WebPromptAnswer getDefaultAnswer()
Returns the default prompt answer if there is any.- Returns:
- the default prompt answer. Null is returned if there is no default prompt answer.
-
delete
void delete(WebPromptAnswer promptAnswer) throws WebObjectsException
Deletes a prompt answer from the collection and also removes it from metadata.- Parameters:
promptAnswer
- the prompt answer object to be removed.- Throws:
WebObjectsException
- thrown if there is any error occurred.
-
save
void save(WebPromptAnswer promptAnswer) throws WebObjectsException
Saves a prompt answer object to the collection as well as in the metadata.- Parameters:
promptAnswer
-- Throws:
WebObjectsException
-
newPromptAnswer
WebPromptAnswer newPromptAnswer()
Creates a prompt answer object but has not yet been persisted in the metadata. This is just a convenient method fromWebObjectSource
.- Returns:
- a new instance of prompt answer object.
-
-