Package com.axemble.vdoc.sdk.impl

Class PortalOptionList

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalElement

com.axemble.vdoc.sdk.impl.PortalList

com.axemble.vdoc.sdk.impl.PortalOptionList

All Implemented Interfaces:

IElement, IList, IOptionList, IDeletionSupport, Serializable

public class PortalOptionList
extends PortalList
implements IOptionList

Author:

vlygeros

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PortalOptionList.Option

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

IList.IType

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

IOptionList.IOption

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalList

list

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalElement

path, storageKey

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Constructor	Description
PortalOptionList(IModule module, com.axemble.webdrive.om.List list)

Method Summary

Modifier and Type	Method	Description
void	delete(IContext context)	Deletes the IElement object.
Collection	getOptions()	Gets the collection of options.
int	getType()	Gets the type of the list
void	setOption(String key, String language, String value)	Creates or updates an option
void	setOptions(Collection options)	Sets the collection of options.

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalList

getDescription, getLabel, getName, getNativeObject, setLabel, setName

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalElement

equals, getId, getPath, getProtocolURI, getProtocolURI, hashCode, replaceBackSlash, replaceSlash, save, setId

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

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

Constructor Details

PortalOptionList

public PortalOptionList(IModule module,
 com.axemble.webdrive.om.List list)

Method Details

getOptions

public Collection getOptions()

Description copied from interface: IOptionList

Gets the collection of options.

Specified by:

getOptions in interface IOptionList

Returns:

A collection of IOptionList.IOption objects.

setOptions

public void setOptions(Collection options)

Description copied from interface: IOptionList

Sets the collection of options.

Specified by:

setOptions in interface IOptionList

Parameters:

options - The collection of IOptionList.IOption objects.

setOption

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

Description copied from interface: IOptionList

Creates or updates an option

Specified by:

setOption in interface IOptionList

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

delete

public void delete(IContext context)

Description copied from interface: IDeletionSupport

Deletes the IElement object.

Specified by:

delete in interface IDeletionSupport

Parameters:

context - The Execution context.

getType

public int getType()

Description copied from interface: IList

Gets the type of the list

Specified by:

getType in interface IList

Returns:

a int value (@see IType)