|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 AdapterType
object when a particular summary
is selected.
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 |
---|
String getId()
null
String identifier.String getDisplayName()
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.
null
String name.ResourceBundle
,
MessageFormat
boolean hasMetadataConnectionTypes()
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.
MetadataConnection
String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
String description.ResourceBundle
,
MessageFormat
String getVendor()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
String representing the vendor.ResourceBundle
,
MessageFormat
String getVersion()
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.
null
String representing the version.ResourceBundle
,
MessageFormat
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |