com.businessobjects.rebean.wi
Interface Prompts

public interface Prompts

The Prompts interface represents a collection of prompts.

A collection of prompts can be returned for a document, or for a list of values that contains nested prompts.

See Also:

DocumentInstance.getPrompts(), Lov.getNestedPrompts(), Prompt

Method Summary

int	getCount() Gets the number of prompts in the collection.
Prompt	getItem(int index) Gets the prompt at the specified position in the collection.
Prompt	getItem(java.lang.String name) Gets a prompt by name.
Prompt	getItemByID(java.lang.String id) Retrieve a Prompt instance from its identifier (Prompt.getID()).

Method Detail

getCount

int getCount()

Gets the number of prompts in the collection.

Returns:

the number of prompts in the collection

getItem

Prompt getItem(int index)
               throws java.lang.IndexOutOfBoundsException

Gets the prompt at the specified position in the collection.

Indexes for the collection of prompts are 0-based.

Parameters:

index - the index of the prompt to return

Returns:

the prompt at the specified position in the collection

Throws:

java.lang.IndexOutOfBoundsException - if index is less than 0 or greater than Prompts.getCount.

See Also:

Prompt

getItem

Prompt getItem(java.lang.String name)
               throws REException

Gets a prompt by name.

This method throws an IllegalArgumentException if the specified prompt is not in the collection.

Parameters:

name - the name of the prompt

Returns:

a prompt with the specified name

Throws:

REException

See Also:

Prompt

getItemByID

Prompt getItemByID(java.lang.String id)

Retrieve a Prompt instance from its identifier (Prompt.getID()).

This method throws an IllegalArgumentException if the prompt identifier could not be found in the collection.

Parameters:

id - the prompt identifier

Returns:

the corresponding Prompt

Since:

12.0

See Also:

Prompt.getID()