commonj.connector.metadata.description
Interface ServiceDescription

All Known Subinterfaces:
InboundServiceDescription, OutboundServiceDescription

public interface ServiceDescription

Describes an interface to EIS functionality. This interface is the base interface for the InboundServiceDescription and OutboundServiceDescription interfaces.

Since:
1.0
See Also:
InboundServiceDescription, OutboundServiceDescription

Method Summary
 BindingDescription[] getBindingDescription()
          A service description can list DataBindings and FunctionSelector it uses or refer to them by name, and have them defined and configured in a BindingRegistry.
 String getComment()
          Contains a description of the service populated from information in the EIS.
 FunctionDescription[] getFunctionDescriptions()
          Returns an array of FunctionDescription instances representing the functions (or rather descriptions of the functions) of this service.
 OutboundConnectionConfiguration getMetadataConnectionConfiguration()
          Returns the metadata connection configuration associated with this service description.
 PropertyGroup getMetadataSelectionProperties()
          Returns the configuration properties of the MetadataSelection.
 String getName()
          If the discovery service can determine a meaningful name for the service then it should populate this field with the value.
 

Method Detail

getName

String getName()
If the discovery service can determine a meaningful name for the service then it should populate this field with the value. Otherwise the discovery service should return null
Returns:
Returns a default name for the service or null if the Discovery Service cannot determine a meaningful default name.

getFunctionDescriptions

FunctionDescription[] getFunctionDescriptions()
Returns an array of FunctionDescription instances representing the functions (or rather descriptions of the functions) of this service.

Returns:
An array of FunctionDescription instances.

getComment

String getComment()
Contains a description of the service populated from information in the EIS. If no pertinent information is available then null can be returned.

This is a locale specific object that should be separated and translated in the EIS, and retrieved using the locale of the tool environment.

Returns:
A String describing the interface or null.

getMetadataConnectionConfiguration

OutboundConnectionConfiguration getMetadataConnectionConfiguration()
Returns the metadata connection configuration associated with this service description.

Returns:
The current metadata connection configuration. Cannot be null as you cannot create a service description without first opening a metadata connection.

getMetadataSelectionProperties

PropertyGroup getMetadataSelectionProperties()
Returns the configuration properties of the MetadataSelection.

Returns:
Returns the MetadataSelection configuration properties. If no configuration properties were set on the MetadataSelection used to create this ServiceDescription then null is returned.
See Also:
MetadataSelection.createSelectionProperties()

getBindingDescription

BindingDescription[] getBindingDescription()
A service description can list DataBindings and FunctionSelector it uses or refer to them by name, and have them defined and configured in a BindingRegistry.

Returns:
an array of BindingDescription.
Since:
1.1