public interface

WebPromptInstance

com.microstrategy.web.objects.WebPromptInstance

Class Overview

The interface WebPromptInstance represends a single prompt instance.

Summary

Public Methods
abstract int getPin()
Returns the pin of the current prompt instance.
abstract WebPrompt getPromptDef()
Returns the prompt definition object corresponding to this prompt instance.
abstract boolean isDormant()
Returns true if the current prompt instance is dormant.
abstract void setPromptDef(WebPrompt promptDef)
Sets and Overwrites a prompt definition object associated with current prompt instance.

Public Methods

public abstract int getPin ()

Returns the pin of the current prompt instance.

Returns
  • the pin of the current prompt instance.

public abstract WebPrompt getPromptDef ()

Returns the prompt definition object corresponding to this prompt instance.

Returns
  • the corresponding prompt definition object.

public abstract boolean isDormant ()

Returns true if the current prompt instance is dormant.

Returns
  • true if the current prompt instance is dormant

public abstract void setPromptDef (WebPrompt promptDef)

Sets and Overwrites a prompt definition object associated with current prompt instance.

Parameters
promptDef a prompt definition object.
Throws
WebObjectsException thrown if the prompt type is not supported on this prompt site.