com.businessobjects.rebean.wi
Interface PromptOrder

public interface PromptOrder

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

PromptOrder interface defines a collection of prompts in the order in which they will be presented to the user.

By default, all prompts will be presented in the creation order, but that can be modified using this class.

Note: The nested prompts doesnot support prompt order

Since:

6.5.0

Method Summary

int	getCount() Returns the number of prompts.
ConditionPrompt	getItem(int index) Returns the prompt at the given position.
void	move(int fromIndex, int toIndex) Moves a prompt from one position to another.

Method Detail

getCount

int getCount()

Returns the number of prompts.

Returns:

the number of prompts

getItem

ConditionPrompt getItem(int index)

Returns the prompt at the given position.

Parameters:

index - the index of the prompt to return

Returns:

the prompt at the given index

Throws:

java.lang.IndexOutOfBoundsException - when index is invalid

move

void move(int fromIndex,
          int toIndex)

Moves a prompt from one position to another.

Parameters:

fromIndex - the index of the prompt to move (must be (fromIndex >= 0) && (fromIndex < getCount()))

toIndex - the index to move the prompt to (must be (toIndex >= 0) && (toIndex < getCount()))

Throws:

java.lang.IndexOutOfBoundsException - when either fromIndex or toIndex is invalid