commonj.connector.metadata.discovery
Interface AdapterTypeSummary

All Known Subinterfaces:
AdapterType

public interface AdapterTypeSummary

Provides summary information about an adapter type sufficient to render in a list or tree node in the tool environment user interface representing the adapter type.

Tool environments can use this interface as a light weight view of its associated AdapterType. This is desirable because the associated AdapterType may be a heavy weight object due to the ConnectionTypes it provides, etc. Thus tool environments can handle, and display, AdapterTypeSummaries and only retrieve the underlying AdapterTypeobject when a particular summary is selected.

Since:
1.0

Method Summary
 String getDescription()
          Gets a description of this adapter type and what EIS it represents.
 String getDisplayName()
          Gets a display name that can be used within the tool environment to represent this adapter type.
 String getId()
          Gets a unique identifier for the AdapterType as a String.
 String getVendor()
          Gets the name of the vendor that supplied this adapter type.
 String getVersion()
          Gets the version of this adapter type (no version naming convention is required, but using a convention where a numeric <major>.<minor>.<patch level> is recommended).
 boolean hasMetadataConnectionTypes()
          Indicates if this adapter type defines any connection type that is appropriate for use during metadata discovery.
 

Method Detail

getId

String getId()
Gets a unique identifier for the AdapterType as a String.

Returns:
a non null String identifier.

getDisplayName

String getDisplayName()
Gets a display name that can be used within the tool environment to represent this adapter type.

Typically this would match the display name specified in the ra.xml of the Resource Adapter.

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

Returns:
a non null String name.
See Also:
ResourceBundle, MessageFormat

hasMetadataConnectionTypes

boolean hasMetadataConnectionTypes()
Indicates if this adapter type defines any connection type that is appropriate for use during metadata discovery.

This is a convinience method for tool environments to use. It allows the tool environment to scope the available adapterTypes for performing metadata discovery. For example, if a tool environment were to provide a dedicated wizard that only performs metadata discovery, it would want to ensure that AdapterTypes that don't support metadata discovery are not available for selection by the user.

Returns:
A boolean value indicating if this adapter type supports metadata only connections.
See Also:
MetadataConnection

getDescription

String getDescription()
Gets a description of this adapter type and what EIS it represents.

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

Returns:
a non null String description.
See Also:
ResourceBundle, MessageFormat

getVendor

String getVendor()
Gets the name of the vendor that supplied this adapter type. Typically this would match the vendor specified in the ra.xml of the Resource Adapter.

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

Returns:
a non null String representing the vendor.
See Also:
ResourceBundle, MessageFormat

getVersion

String getVersion()
Gets the version of this adapter type (no version naming convention is required, but using a convention where a numeric <major>.<minor>.<patch level> is recommended).

Typically this would match the version specified in the ra.xml of the Resource Adapter.

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

Returns:
a non null String representing the version.
See Also:
ResourceBundle, MessageFormat