WebPromptInstance (Web API 2021)

```
public interface WebPromptInstance
```
The interface WebPromptInstance represends a single prompt instance.

Since:

MicroStrategy Web 9.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getPin()`	Returns the pin of the current prompt instance.
`WebPrompt`	`getPromptDef()`	Returns the prompt definition object corresponding to this prompt instance.
`boolean`	`isDormant()`	Returns `true` if the current prompt instance is dormant.
`boolean`	`isSystemPrompt()`	Returns `true` if the current prompt is system prompt.
`void`	`setPromptDef(WebPrompt promptDef)`	Sets and Overwrites a prompt definition object associated with current prompt instance.
`void`	`setSystemPrompt(boolean isSystemPrompt)`

- Method Detail
  - getPromptDef
```
WebPrompt getPromptDef()
```
    Returns the prompt definition object corresponding to this prompt instance.
    
    Returns:
    
    the corresponding prompt definition object.
  - isDormant
```
boolean isDormant()
```
    Returns true if the current prompt instance is dormant.
    
    Returns:
    
    true if the current prompt instance is dormant
  - isSystemPrompt
```
boolean isSystemPrompt()
```
    Returns true if the current prompt is system prompt.
    
    Returns:
    
    false if the current prompt is not system prompt
  - setSystemPrompt
```
void setSystemPrompt(boolean isSystemPrompt)
```
  - getPin
```
int getPin()
```
    Returns the pin of the current prompt instance.
    
    Returns:
    
    the pin of the current prompt instance.
  - setPromptDef
```
void setPromptDef(WebPrompt promptDef)
           throws WebObjectsException
```
    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.