Package com.axemble.vdoc.sdk.impl

Class PortalProperty

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalElement

com.axemble.vdoc.sdk.impl.PortalProperty

All Implemented Interfaces:

IElement, IProperty, IConnectorParentContextSupport, IProtocolSupport, Serializable

public class PortalProperty
extends PortalElement
implements IProperty

Author:

vlygeros

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PortalProperty.DisplaySettings

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

IProperty.Dynamic, IProperty.IAdditionalType, IProperty.IDisplaySettings, IProperty.IElementType, IProperty.IIndexType, IProperty.IType, IProperty.Special, IProperty.System

Field Summary

Fields

Modifier and Type	Field	Description
protected com.axemble.webdrive.om.PropertyDefinition	property

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
PortalProperty(IModule module, com.axemble.webdrive.om.PropertyDefinition property)

Method Summary

Modifier and Type	Method	Description
int	getAdditionalType()	Retrieves the additional type of the property.
Object	getDefaultValue()	Retrieves the default value.
IResourceDefinition	getDefinition()	Retrieves the IResourceDefinition of the property.
String	getDescription()	Gets the description of the property.
IProperty.IDisplaySettings	getDisplaySettings()	Retrieves the display settings of the property.
int	getElementType()	Gets the element type.
IResourceDefinition	getForeignResourceDefinition()	Gets the foreign resource definition.
int	getIndexType()	Gets the index type.
String	getLabel()	Gets the localized label of the property.
IList	getList()	Retrieves the associated list.
IList	getList(ILibrary library)	Retrieves the associated list.
String	getName()	Gets the system name of the property.
Object	getNativeObject()	Gets the native object underneath.
IProtocolSupport	getParentContext()	Gets the container for the parent object of the service
int	getType()	Retrieves the type of the property.
boolean	hasList()	Checks if the property is associated with a list.
boolean	isCollection()	Checks if the stored value has multiple values.
boolean	isIndexed()	Checks if the property will be indexed.
void	setDefaultValue(Object defaultValue)	Sets teh default value of the property.
void	setIndexType(int indexType)	Sets the index type of the property.
void	setLabel(String label)	Sets the label of the property in the current language.
void	setList(IList list)	Associates a list to the property.
void	setName(String name)	Sets the system name of the property.
void	setType(int type)	Sets the type of the property.

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, getPath, save

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

getProtocolURI, getProtocolURI

Field Details

property

protected com.axemble.webdrive.om.PropertyDefinition property

Constructor Details

PortalProperty

public PortalProperty(IModule module,
 com.axemble.webdrive.om.PropertyDefinition property)

Method Details

getNativeObject

public Object getNativeObject()

Description copied from interface: IElement

Gets the native object underneath.

Specified by:

getNativeObject in interface IElement

Returns:

an object.

getName

public String getName()

Description copied from interface: IProperty

Gets the system name of the property.

Specified by:

getName in interface IProperty

Returns:

A java.lang.String value.

setName

public void setName(String name)

Description copied from interface: IProperty

Sets the system name of the property.

Specified by:

setName in interface IProperty

Parameters:

name - The new name of the property.

getLabel

public String getLabel()

Description copied from interface: IProperty

Gets the localized label of the property.

Specified by:

getLabel in interface IProperty

Returns:

A java.lang.String value.

setLabel

public void setLabel(String label)

Description copied from interface: IProperty

Sets the label of the property in the current language.

Specified by:

setLabel in interface IProperty

Parameters:

label - The new label of the property.

getDescription

public String getDescription()

Description copied from interface: IProperty

Gets the description of the property.

Specified by:

getDescription in interface IProperty

Returns:

A java.lang.String value.

isCollection

public boolean isCollection()

Description copied from interface: IProperty

Checks if the stored value has multiple values.

Specified by:

isCollection in interface IProperty

Returns:

true if the property accepts several values, false otherwise.

getDefaultValue

public Object getDefaultValue()

Description copied from interface: IProperty

Retrieves the default value.

Specified by:

getDefaultValue in interface IProperty

Returns:

An Object object.

setDefaultValue

public void setDefaultValue(Object defaultValue)

Description copied from interface: IProperty

Sets teh default value of the property.

Specified by:

setDefaultValue in interface IProperty

Parameters:

defaultValue - The default value.

getDefinition

public IResourceDefinition getDefinition()

Description copied from interface: IProperty

Retrieves the IResourceDefinition of the property.

Specified by:

getDefinition in interface IProperty

Returns:

A IResourceDefinition object.

isIndexed

public boolean isIndexed()

Description copied from interface: IProperty

Checks if the property will be indexed.

Specified by:

isIndexed in interface IProperty

Returns:

true if the property is indexed, false otherwise.

getIndexType

public int getIndexType()

Description copied from interface: IProperty

Gets the index type.

Specified by:

getIndexType in interface IProperty

Returns:

A value of the IProperty.IIndexType.

setIndexType

public void setIndexType(int indexType)

Description copied from interface: IProperty

Sets the index type of the property.

Specified by:

setIndexType in interface IProperty

Parameters:

indexType - A value of the IProperty.IIndexType

getType

public int getType()

Description copied from interface: IProperty

Retrieves the type of the property.

Specified by:

getType in interface IProperty

Returns:

A IProperty.IType.

setType

public void setType(int type)

Description copied from interface: IProperty

Sets the type of the property.

Specified by:

setType in interface IProperty

Parameters:

type - A value of the IProperty.IType.

hasList

public boolean hasList()

Description copied from interface: IProperty

Checks if the property is associated with a list.

Specified by:

hasList in interface IProperty

Returns:

true if the property is associated with a list, false otherwise.

getAdditionalType

public int getAdditionalType()

Description copied from interface: IProperty

Retrieves the additional type of the property.

Specified by:

getAdditionalType in interface IProperty

Returns:

A IProperty.IAdditionalType.

setList

public void setList(IList list)

Description copied from interface: IProperty

Associates a list to the property.

Specified by:

setList in interface IProperty

Parameters:

list - The list to associate the property.

getList

public IList getList(ILibrary library)

Description copied from interface: IProperty

Retrieves the associated list. Only available for the

Specified by:

getList in interface IProperty

Parameters:

library - The library where the list is defined.

Returns:

A IList object.

getList

public IList getList()

Description copied from interface: IProperty

Retrieves the associated list.

Specified by:

getList in interface IProperty

Returns:

A IList object.

getDisplaySettings

public IProperty.IDisplaySettings getDisplaySettings()

Description copied from interface: IProperty

Retrieves the display settings of the property.

Specified by:

getDisplaySettings in interface IProperty

Returns:

A IProperty.IDisplaySettings object.

getElementType

public int getElementType()

Description copied from interface: IProperty

Gets the element type.

Specified by:

getElementType in interface IProperty

Returns:

A value of the IProperty.IElementType.

getForeignResourceDefinition

public IResourceDefinition getForeignResourceDefinition()

Description copied from interface: IProperty

Gets the foreign resource definition. Used for data stockroom.

Specified by:

getForeignResourceDefinition in interface IProperty

Returns:

A IResourceDefinition object.

getParentContext

public IProtocolSupport getParentContext()

Description copied from interface: IConnectorParentContextSupport

Gets the container for the parent object of the service

Specified by:

getParentContext in interface IConnectorParentContextSupport

Returns:

a IProtocolSupport object.