Package com.axemble.vdoc.sdk.interfaces

Interface IOptionList

All Superinterfaces:

IDeletionSupport, IElement, IList, Serializable

All Known Implementing Classes:

PortalOptionList

public interface IOptionList
extends IList, IDeletionSupport

The option list interface

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

• IList

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IOptionList.IOption	A key, value couple object.

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.IList

IList.IType

Method Summary

Modifier and Type	Method	Description
Collection<? extends IOptionList.IOption>	getOptions()	Gets the collection of options.
void	setOption(String key, String language, String value)	Creates or updates an option
void	setOptions(Collection<IOptionList.IOption> options)	Sets the collection of options.

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IList

getDescription, getLabel, getName, getType

Method Details

getOptions

Collection<? extends IOptionList.IOption> getOptions()

Gets the collection of options.

Returns:

A collection of IOptionList.IOption objects.

setOptions

void setOptions(Collection<IOptionList.IOption> options)

Sets the collection of options.

Parameters:

options - The collection of IOptionList.IOption objects.

setOption

void setOption(String key,
 String language,
 String value)

Creates or updates an option

Parameters:

key - : if the key exists, the value will be updated, else it will be created

language - : the language to modify

value - : the value of the option to set