Package com.microstrategy.web.objects

Interface WebPromptInstances

public interface WebPromptInstances

The interface WebPromptInstances represents a collection of prompt instances.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the whole collection;
WebPromptInstance	findByPin(int pin)	Returns the prompt instance with the specified pin.
WebPromptInstance	get(int index)	Returns the prompt instance at the specified position.
boolean	isEmpty()	Returns true if the collection is empty.
WebPromptInstance	newPromptInstance()	Creates and stores a prompt instance.
WebPromptInstance	newPromptInstance(WebPrompt promptDef)	Creates and stores a prompt instance.
WebPromptInstance	newPromptInstance(WebPrompt promptDef, boolean isSystemPrompt)	Creates and stores a prompt instance.
void	remove(int index)	Removes the prompt instance at the specified position.
void	removeByPin(int pin)	Removes the prompt instance with the specified pin.
int	size()	Returns the number of prompt instances from this collection.

Method Detail

size

int size()

Returns the number of prompt instances from this collection.

Returns:

the number of prompt instances.

isEmpty

boolean isEmpty()

Returns true if the collection is empty.

Returns:

true if the collection is empty.

get

WebPromptInstance get(int index)

Returns the prompt instance at the specified position.

Parameters:

index - the position of a prompt instance

Returns:

the prompt instance at the specified position.

findByPin

WebPromptInstance findByPin(int pin)

Returns the prompt instance with the specified pin.

Parameters:

pin - the pin of a prompt instance

Returns:

the prompt instance with the specified pin.

remove

void remove(int index)

Removes the prompt instance at the specified position.

Parameters:

index - the position of a prompt instance.

removeByPin

void removeByPin(int pin)

Removes the prompt instance with the specified pin.

Parameters:

pin - pin the pin of a prompt instance

newPromptInstance

WebPromptInstance newPromptInstance()

Creates and stores a prompt instance.

Returns:

the new prompt instance just being created.

newPromptInstance

WebPromptInstance newPromptInstance(WebPrompt promptDef)
                             throws WebObjectsException

Creates and stores a prompt instance. The newly created prompt instance is linked to the specified prompt definition.

Parameters:

promptDef - a prompt definition.

Returns:

the new prompt instance just being created.

Throws:

WebObjectsException - thrown if the prompt type is not supported on this prompt site.

newPromptInstance

WebPromptInstance newPromptInstance(WebPrompt promptDef,
                                    boolean isSystemPrompt)
                             throws WebObjectsException

Creates and stores a prompt instance. The newly created prompt instance is linked to the specified prompt definition.

Parameters:

promptDef - a prompt definition.

isSystemPrompt - boolean true if this is a system prompt

Returns:

the new prompt instance just being created.

Throws:

WebObjectsException - thrown if the prompt type is not supported on this prompt site.

clear

void clear()

Clear the whole collection;