com.sun.ams

Interface SuiteSetting

public interface SuiteSetting

Interface for the individual suite setting. Each setting has an optional title to be displayed to user (for example, "Read File"), optional description (for example, "How often should app ask for permission to access to file system reading?") and number of choices (for example, "Ask once per application use", etc).

Method Summary

Methods

Modifier and Type	Method and Description
int	getChoicesCount() Gets number of choices for this setting
java.lang.String	getChoiceTitle(int idx) Title of choice with specified index.
java.lang.String	getDescription() Gets setting description
int	getIdx() Gets setting index in settings group
int	getSelectedChoice() Return index of currently selected (active) choice
java.lang.String	getTitle() Gets setting title
void	setSelectedChoice(int newSelection) Sets index currently selected by user.

Method Detail

getIdx

int getIdx()

Gets setting index in settings group

Returns:

setting index in settings group

getTitle

java.lang.String getTitle()

Gets setting title

Returns:

setting title, or null if there is no title

getDescription

java.lang.String getDescription()

Gets setting description

Returns:

setting description, or null if there is no description

getChoicesCount

int getChoicesCount()

Gets number of choices for this setting

Returns:

number of choices for this setting

getSelectedChoice

int getSelectedChoice()

Return index of currently selected (active) choice

Returns:

index of currently selected (active) choice

setSelectedChoice

void setSelectedChoice(int newSelection)
                       throws java.lang.IndexOutOfBoundsException

Sets index currently selected by user. To apply new selection settings should be saved.

Parameters:

newSelection - new selection

Throws:

java.lang.IndexOutOfBoundsException - if selection index is not valid

getChoiceTitle

java.lang.String getChoiceTitle(int idx)

Title of choice with specified index.

Parameters:

idx - choice index

Returns:

choice title