Package com.axemble.vdoc.sdk.impl

Class PortalResourceDefinition

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalElement

com.axemble.vdoc.sdk.impl.PortalResourceDefinition

All Implemented Interfaces:

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

public class PortalResourceDefinition
extends PortalElement
implements IResourceDefinition

Author:

vlygeros

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected com.axemble.webdrive.om.DocumentDefinition	documentDefinition
protected IForm	form

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

Modifier	Constructor	Description
protected	PortalResourceDefinition(IModule module, com.axemble.webdrive.om.DocumentDefinition documentDefinition)

Method Summary

Modifier and Type	Method	Description
void	delete(IContext context)	Deletes the IElement object.
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.
Object	getNativeObject()	Gets the native object underneath.
IProtocolSupport	getParentContext()	Gets the container for the parent object of the service
Collection	getProperties()	Gets all the properties of the definition.
IProperty	getProperty(String name)	Gets a property definition by its specified system name.

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

documentDefinition

protected com.axemble.webdrive.om.DocumentDefinition documentDefinition

form

protected IForm form

Constructor Details

PortalResourceDefinition

protected PortalResourceDefinition(IModule module,
 com.axemble.webdrive.om.DocumentDefinition documentDefinition)

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: IResourceDefinition

Gets the system name of the definition.

Specified by:

getName in interface IResourceDefinition

Returns:

a String object.

getLabel

public String getLabel()

Description copied from interface: IResourceDefinition

Gets the label of the definition.

Specified by:

getLabel in interface IResourceDefinition

Returns:

a String object.

getDescription

public String getDescription()

Specified by:

getDescription in interface IResourceDefinition

Returns:

The description of the definition.

getForm

public IForm getForm()

Description copied from interface: IResourceDefinition

Gets the default form associated to the definition.

Specified by:

getForm in interface IResourceDefinition

Returns:

a IForm object.

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.

getProperties

public Collection getProperties()

Description copied from interface: IResourceDefinition

Gets all the properties of the definition.

Specified by:

getProperties in interface IResourceDefinition

Returns:

a collection of IProperty objects.

getProperty

public IProperty getProperty(String name)

Description copied from interface: IResourceDefinition

Gets a property definition by its specified system name.

Specified by:

getProperty in interface IResourceDefinition

Parameters:

name - the system name of the property.

Returns:

a IProperty 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.