com.axemble.vdoc.sdk.interfaces

Interface IConnectionDefinition<T>

All Superinterfaces:

IDeletionSupport, IElement, IExternalReference, IProtocolSupport, ISecuritySupport, Serializable

public interface IConnectionDefinition<T>
extends IExternalReference, IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport

This class retrieves a connection from a specified external reference declared in the administration

Author:

ploureiro

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IConnectionDefinition.ICategory Systems or standards Category.
static interface	IConnectionDefinition.IType Systems or standards types.

Method Summary

Modifier and Type	Method and Description
String	getCategoryName()
T	getConnection() Gets a connection for the specified connection declared in the administration
String	getDescription()
String	getLabel()
IOrganization	getOrganization() Gets the organization object.
Object	getValue(String propertyName) Gets the value of a property.
Map<String,Object>	getValues()
void	setValue(String propertyName, Object value) Sets a value to a property

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

getName

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

delete

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

getId, getModule, getNativeObject, getPath, save

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

getProtocolURI, getProtocolURI

Method Detail

getLabel

String getLabel()

Returns:

the label of the connection.

getDescription

String getDescription()

Returns:

the description of the connection.

getOrganization

IOrganization getOrganization()

Gets the organization object.

Returns:

A IOrganization object.

getCategoryName

String getCategoryName()

Returns:

the categoryName of the connection

setValue

void setValue(String propertyName,
              Object value)

Sets a value to a property

Parameters:

propertyName - The system name of the property.

value - The value object to set.

getValue

Object getValue(String propertyName)

Gets the value of a property.

Parameters:

propertyName - The system name of the property.

Returns:

A Object object.

getValues

Map<String,Object> getValues()

Returns:

all configuration values

getConnection

T getConnection()

Gets a connection for the specified connection declared in the administration

Returns:

Connection object