+

Search Tips | Advanced Search

com.ibm.workplace.wcm.api
Interface OptionSelectionComponent

All Superinterfaces:

ContentComponent

public interface OptionSelectionComponent
extends ContentComponent

Represents a OptionSelection component.

A OptionSelectionComponent is a ContentComponent and cannot be stored as a separate entity in the repository.

A OptionSelectionComponent can contain array of String values. This interface provides methods to retrieve and set the array of Strings contained within this component.

note: since v6.0.0, a ContentComponent is referred to as an "Element" in the Authoring UI.

See Also:

ContentComponent

Method Summary

java.lang.String[]	getAvailableSelectionValues() Returns the array of available options defined in the authoring template for this OptionSelectionComponent
java.lang.String[]	getSelections() Returns the array of Strings contained in this component as a String[].
boolean	isSingleSelect() Returns true if this OptionSelectionComponent has been configured within the authoring template to be single select, false if not.
void	setSelections(java.lang.String[] selections) Sets the String[] contained in this OptionSelectionComponent.

Methods inherited from interface com.ibm.workplace.wcm.api.ContentComponent

getContainer, getName

Method Detail

getSelections

 java.lang.String[] getSelections()

Returns the array of Strings contained in this component as a String[].

Returns null if the values is not set.

Returns:

the String[]

setSelections

 void setSelections(java.lang.String[] selections)
                   throws OperationFailedException

Sets the String[] contained in this OptionSelectionComponent.

Note. This method replaces any existing String[] in this component.

Parameters:

selections - the String[]

Throws:

OperationFailedException - if the String[] argument is null or the selections could not be set

getAvailableSelectionValues

 java.lang.String[] getAvailableSelectionValues()

Returns the array of available options defined in the authoring template for this OptionSelectionComponent

Returns null if the values is not set.

Returns:

the String[]

isSingleSelect

 boolean isSingleSelect()

Returns true if this OptionSelectionComponent has been configured within the authoring template to be single select, false if not.

Returns:

boolean true if this OptionSelectionComponent is is configured to be single select, false if not