com.axemble.vdoc.sdk.interfaces

Interface IProperty

All Superinterfaces:

IConnectorParentContextSupport, IElement, IProtocolSupport, Serializable

public interface IProperty
extends IElement, IConnectorParentContextSupport, IProtocolSupport

A property

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IResource, IWorkflowInstance, ILinkedResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IProperty.Dynamic Dynamic properties
static interface	IProperty.IAdditionalType Additional types
static interface	IProperty.IDisplaySettings Display settings
static interface	IProperty.IElementType The type of the java.util.Collection items.
static interface	IProperty.IIndexType Index search types
static interface	IProperty.IType All supported types
static interface	IProperty.Special Special properties.
static interface	IProperty.System System properties

Method Summary

Modifier and Type	Method and 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) Deprecated. Use getList( IContext context, ILibrary library, String name ) method instead from the IBaseLibraryModule.
String	getName() Gets the system name of the property.
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 interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

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

getParentContext

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

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Gets the system name of the property.

Returns:

A java.lang.String value.

setName

void setName(String name)

Sets the system name of the property.

Parameters:

name - The new name of the property.

getLabel

String getLabel()

Gets the localized label of the property.

Returns:

A java.lang.String value.

setLabel

void setLabel(String label)

Sets the label of the property in the current language.

Parameters:

label - The new label of the property.

getDescription

String getDescription()

Gets the description of the property.

Returns:

A java.lang.String value.

getType

int getType()

Retrieves the type of the property.

Returns:

A IProperty.IType.

setType

void setType(int type)

Sets the type of the property.

Parameters:

type - A value of the IProperty.IType.

getAdditionalType

int getAdditionalType()

Retrieves the additional type of the property.

Returns:

A IProperty.IAdditionalType.

isCollection

boolean isCollection()

Checks if the stored value has multiple values.

Returns:

true if the property accepts several values, false otherwise.

getDefaultValue

Object getDefaultValue()

Retrieves the default value.

Returns:

An Object object.

setDefaultValue

void setDefaultValue(Object defaultValue)

Sets teh default value of the property.

Parameters:

defaultValue - The default value.

hasList

boolean hasList()

Checks if the property is associated with a list.

Returns:

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

getList

IList getList()

Retrieves the associated list.

Returns:

A IList object.

setList

void setList(IList list)

Associates a list to the property.

Parameters:

list - The list to associate the property.

getList

@Deprecated
IList getList(ILibrary library)

Deprecated. Use getList( IContext context, ILibrary library, String name ) method instead from the IBaseLibraryModule.

Retrieves the associated list. Only available for the

Parameters:

library - The library where the list is defined.

Returns:

A IList object.

isIndexed

boolean isIndexed()

Checks if the property will be indexed.

Returns:

true if the property is indexed, false otherwise.

getIndexType

int getIndexType()

Gets the index type.

Returns:

A value of the IProperty.IIndexType.

setIndexType

void setIndexType(int indexType)

Sets the index type of the property.

Parameters:

indexType - A value of the IProperty.IIndexType

getDefinition

IResourceDefinition getDefinition()

Retrieves the IResourceDefinition of the property.

Returns:

A IResourceDefinition object.

getDisplaySettings

IProperty.IDisplaySettings getDisplaySettings()

Retrieves the display settings of the property.

Returns:

A IProperty.IDisplaySettings object.

getElementType

int getElementType()

Gets the element type.

Returns:

A value of the IProperty.IElementType.

getForeignResourceDefinition

IResourceDefinition getForeignResourceDefinition()

Gets the foreign resource definition. Used for data stockroom.

Returns:

A IResourceDefinition object.