com.cognos.CAM_AAA.authentication

Class SingleSelectDisplayObject

java.lang.Object

com.cognos.CAM_AAA.authentication.SingleSelectDisplayObject

All Implemented Interfaces:

IDisplayObject, ISingleSelectDisplayObject, ITextDisplayObject

Direct Known Subclasses:

MultiSelectDisplayObject

public class SingleSelectDisplayObject
extends java.lang.Object
implements ISingleSelectDisplayObject

A display object that presents a list of selectable values to the user, where one entry can be chosen from list. If the user does not choose an item, then an empty select option is added. If more than one value is selected, then a form field variable will exist for each value selected.

Constructor Summary

Constructors

Constructor and Description
SingleSelectDisplayObject(java.lang.String theCaption, java.lang.String theName) Creates a single-select display object.

Method Summary

Modifier and Type	Method and Description
void	addOption(ISelectOption theSelectOption) Adds a selectable option to the list of available selections.
java.lang.String	getCaption() Returns the caption for this display object.
java.lang.String	getName() Returns the name of the display object.
ISelectOption[]	getOptions() Returns the options that are available for the user to select.
java.lang.String	getValue() Returns the value that is currently set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleSelectDisplayObject

public SingleSelectDisplayObject(java.lang.String theCaption,
                                 java.lang.String theName)

Creates a single-select display object.

Parameters:

theCaption - The label of the single-select display object.

theName - The name of the single-select display object.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IDisplayObject

Returns the name of the display object.

Specified by:

getName in interface IDisplayObject

Returns:

The name of the display object.

getValue

public java.lang.String getValue()

Description copied from interface: IDisplayObject

Returns the value that is currently set.

Specified by:

getValue in interface IDisplayObject

Returns:

The value that is currently set.

getCaption

public java.lang.String getCaption()

Description copied from interface: ITextDisplayObject

Returns the caption for this display object.

Specified by:

getCaption in interface ITextDisplayObject

Returns:

The caption for this display object.

addOption

public void addOption(ISelectOption theSelectOption)

Adds a selectable option to the list of available selections.

Parameters:

theSelectOption - The option to be added.

getOptions

public ISelectOption[] getOptions()

Description copied from interface: ISingleSelectDisplayObject

Returns the options that are available for the user to select. Returns null if no selection options exist.

Specified by:

getOptions in interface ISingleSelectDisplayObject

Returns:

An array containing the selection options for this display object.