commonj.connector.metadata.description
Interface DataDescription

All Known Subinterfaces:
DataDescription, FaultDataDescription

public interface DataDescription

Describes a data element that can be used as a request, response, or notification payload for a FunctionDescription.

Since:
1.0

Method Summary
 String getBindingConfigurationName()
          Returns the binding configuration name to be used with the BindingRegistry.
 String getComment()
          Contains a description of the data populated from information in the EIS.
 String getDataBindingGeneratorClassName()
          Returns the DataBindingGenerator class name which generates the DataBinding or cci.Record implementation.
 DataFile[] getDataFiles()
          This method returns an array of DataFile which represent auxiliary files.
 String getGenericDataBindingClassName()
          Returns the class name of either generic DataBinding or generic Record.
 QName getName()
          This method returns the name of the global element or complexType that is used as the method argument on the FunctionDescription instance.
 SchemaDefinition[] getSchemaDefinitions()
          This method returns the schema that describes the input or output types.
 

Method Detail

getDataBindingGeneratorClassName

String getDataBindingGeneratorClassName()
Returns the DataBindingGenerator class name which generates the DataBinding or cci.Record implementation. The form is the package and class name. For example "java.lang.String".

It is required that the DataBindingGenerator have a public default constructor.

It is required that one of the methods getDataBindingGeneratorClassName(), getGenericDataBindingClassName() or getBindingConfigurationName() returns a non-null value.

Returns:
The fully qualified class name of the DataBindngGenerator class or null.

getGenericDataBindingClassName

String getGenericDataBindingClassName()
Returns the class name of either generic DataBinding or generic Record. The name is a fully qualified name containing package and class name, for example "java.lang.String".

It is required that the generic DataBinding or generic Record have a public default constructor.

It is required that one of the methods of the getDataBindingGeneratorClassName(), getGenericDataBindingClassName() or getBindingConfigurationName() returns a non-null value.

Returns:
Either the fully qualified name of the generic DataBindng or generic Record class, or null.

getName

QName getName()
This method returns the name of the global element or complexType that is used as the method argument on the FunctionDescription instance.

Returns:
Name of the global element or complextype that is used as the method argument on the FunctionDescription instance. If a global element is specified then it must have a complexType.

getSchemaDefinitions

SchemaDefinition[] getSchemaDefinitions()
This method returns the schema that describes the input or output types.

If SchemaDefinitions use relative path imports or includes then all referenced schema must be returned in this array. If the SchemaDefinitions use absolute path then only the first absolute SchemaDefinition should be included in this array. Schema definitions that are imported or included by the absolute SchemaDefinition should not be included in the array list.

Returns:
An array of SchemaDefinitions which describe the input or output type, or null if a common schema is specified.
See Also:
MetadataBuild.getCommonSchemaTypes(), MetadataBuild.getCommonSchemas(QName)

getDataFiles

DataFile[] getDataFiles()
This method returns an array of DataFile which represent auxiliary files. The auxiliary files can be used by the dataBinding to perform data transformation to data objects.

Returns:
an array of DataFile. null is returned if no auxiliary files are required.

getComment

String getComment()
Contains a description of the data populated from information in the EIS. If no pertinent information is available then null is 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 data or null.

getBindingConfigurationName

String getBindingConfigurationName()
Returns the binding configuration name to be used with the BindingRegistry.

It is required that one of the methods of the getDataBindingGeneratorClassName(), getGenericDataBindingClassName() or getBindingConfigurationName() returns a non-null value.

Returns:
the configuration name for the configured DataBinding or null.
Since:
1.1