com.axemble.vdoc.sdk.interfaces

Interface IResourceDefinition

All Superinterfaces:

IConnectorParentContextSupport, IDeletionSupport, IElement, IProtocolSupport, IScopeContainer, ISearchSupport, ISecuritySupport, Serializable

All Known Subinterfaces:

ILinkedResourceDefinition, IStorageResourceDefinition, IWorkflowResourceDefinition

public interface IResourceDefinition
extends IElement, IDeletionSupport, ISecuritySupport, ISearchSupport, IProtocolSupport, IScopeContainer, IConnectorParentContextSupport

This class defines a resource which may have several IProperty objects.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IWorkflowInstance, ILinkedResource, IFile, IProperty, IResource

Method Summary

Modifier and Type	Method and Description
String	getDescription()
IForm	getForm() Gets the default form associated to the definition.
String	getLabel() Gets the label of the definition.
String	getName() Gets the system name of the definition.
Collection<? extends IProperty>	getProperties() Gets all the properties of the definition.
IProperty	getProperty(String name) Gets a property definition by its specified system name.

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

getId, getModule, getNativeObject, getPath, save

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

delete

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

getParentContext

Method Detail

getName

String getName()

Gets the system name of the definition.

Returns:

a String object.

getLabel

String getLabel()

Gets the label of the definition.

Returns:

a String object.

getDescription

String getDescription()

Returns:

The description of the definition.

getProperties

Collection<? extends IProperty> getProperties()

Gets all the properties of the definition.

Returns:

a collection of IProperty objects.

getProperty

IProperty getProperty(String name)

Gets a property definition by its specified system name.

Parameters:

name - the system name of the property.

Returns:

a IProperty object.

getForm

IForm getForm()

Gets the default form associated to the definition.

Returns:

a IForm object.