public interface

WebPromptInstances

com.microstrategy.web.objects.WebPromptInstances

Class Overview

The interface WebPromptInstances represents a collection of prompt instances.

Summary

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

Public Methods

public abstract void clear ()

Clear the whole collection;

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

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

public abstract boolean isEmpty ()

Returns true if the collection is empty.

Returns
  • true if the collection is empty.

public abstract WebPromptInstance newPromptInstance ()

Creates and stores a prompt instance.

Returns
  • the new prompt instance just being created.

public abstract WebPromptInstance newPromptInstance (WebPrompt promptDef)

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.

public abstract void remove (int index)

Removes the prompt instance at the specified position.

Parameters
index the position of a prompt instance.

public abstract void removeByPin (int pin)

Removes the prompt instance with the specified pin.

Parameters
pin pin the pin of a prompt instance

public abstract int size ()

Returns the number of prompt instances from this collection.

Returns
  • the number of prompt instances.