public interface

WebUserAnswers

com.microstrategy.web.objects.WebUserAnswers

Class Overview

The WebUserAnswers interface holds a collection of WebPromptAnswer. It comes from executing a prompted report or document.

Summary

Public Methods
abstract void delete(WebPromptAnswer promptAnswer)
Deletes a prompt answer from the collection and also removes it from metadata.
abstract WebPromptAnswer get(int index)
Returns the prompt answer object at the specified position.
abstract Iterator getAnswers()
Returns an iterator over the collection of prompt answer objects.
abstract WebPromptAnswer getDefaultAnswer()
Returns the default prompt answer if there is any.
abstract WebPromptAnswer newPromptAnswer()
Creates a prompt answer object but has not yet been persisted in the metadata.
abstract void save(WebPromptAnswer promptAnswer)
Saves a prompt answer object to the collection as well as in the metadata.
abstract int size()
Returns the number of prompt answer objects in the collection.

Public Methods

public abstract void delete (WebPromptAnswer promptAnswer)

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.

public abstract 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.

public abstract Iterator getAnswers ()

Returns an iterator over the collection of prompt answer objects.

Returns
  • an iterator over the collection of prompt answer objects.

public abstract 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.

public abstract WebPromptAnswer newPromptAnswer ()

Creates a prompt answer object but has not yet been persisted in the metadata. This is just a convenient method from WebObjectSource.

Returns
  • a new instance of prompt answer object.

public abstract void save (WebPromptAnswer promptAnswer)

Saves a prompt answer object to the collection as well as in the metadata.

Throws
WebObjectsException

public abstract int size ()

Returns the number of prompt answer objects in the collection.

Returns
  • the number of prompt answer objects in the collection.