commonj.connector.metadata.discovery.connection
Interface ConnectionPersistence.ConnectionSummary

Enclosing interface:
ConnectionPersistence

public static interface ConnectionPersistence.ConnectionSummary

Summary information for a persisted connection configuration.


Method Summary
 ConnectionType getConnectionType()
          Get the type of the connection described by the summary.
 String getDescription()
          A description of the connection configuration.
 String getName()
          Get the name that uniquely defines the connection configuration within the adapter Type and ConnectionType scope The return value must not be null.
 boolean isInbound()
          Information whether the connection configuration is inbound connection configuration
 boolean isOutbound()
          Information whether the connection configuration is outbound connection configuration
 

Method Detail

getConnectionType

ConnectionType getConnectionType()
Get the type of the connection described by the summary.

Returns:
ConnectionType The connection type that created configuration described by the summary. The return value must not be null.
See Also:
ConnectionConfiguration.getConnectionType()

getName

String getName()
Get the name that uniquely defines the connection configuration within the adapter Type and ConnectionType scope The return value must not be null.

Returns:
Unique name of the configuraion
See Also:
ConnectionConfiguration.getName()

getDescription

String getDescription()
A description of the connection configuration.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
description A description of the connection configuration.
See Also:
ResourceBundle, MessageFormat, ConnectionConfiguration.getDescription()

isInbound

boolean isInbound()
Information whether the connection configuration is inbound connection configuration

Returns:
true if inbound configuration

isOutbound

boolean isOutbound()
Information whether the connection configuration is outbound connection configuration

Returns:
true if outbound configuration