commonj.connector.metadata.build.tool
Interface DataDescription

All Superinterfaces:
DataDescription

public interface DataDescription
extends DataDescription

In build scenario when FunctionBuilder.updateFunctionDescription is invoked, allow the adapter to update the DataDescription.

All DataDescriptions provided by the tool in the build scenario must implement this interface.

Since:
1.1
See Also:
DataDescription

Method Summary
 boolean isReadOnly()
          Indicates to the tool that the DataDescription should be shown to the user, but not allowed to be changed.
 void setBindingConfigurationName(String bindingConfigName)
          Sets the binding configuration name.
 void setDataBindingGeneratorClassName(String name)
          Sets the DataBindingGenerator class name which generates the DataBinding or cci.Record implementation.
 void setGenericDataBindingClassName(String name)
          Sets the class name of either generic DataBinding or generic Record.
 void setName(QName name)
          Sets the name of the global element or complexType that is used as the method argument on the FunctionDescription instance.
 void setReadOnly(boolean readOnly)
          Sets the DataDescription to be read only.
 void setSchemaDefinitions(SchemaDefinition[] definitions)
          Sets the schema that describes the input or output types.
 
Methods inherited from interface commonj.connector.metadata.description.DataDescription
getBindingConfigurationName, getComment, getDataBindingGeneratorClassName, getDataFiles, getGenericDataBindingClassName, getName, getSchemaDefinitions
 

Method Detail

setDataBindingGeneratorClassName

void setDataBindingGeneratorClassName(String name)
Sets 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".

Parameters:
name - is the fully qualified className of the DataBindingGenerator.

setGenericDataBindingClassName

void setGenericDataBindingClassName(String name)
Sets 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".

Parameters:
name - is the fully qualified className of the DataBinding or generic Record.

setSchemaDefinitions

void setSchemaDefinitions(SchemaDefinition[] definitions)
Sets the schema that describes the input or output types.

Parameters:
definitions - is the array of SchemaDefinitions which describe the input or output type.

isReadOnly

boolean isReadOnly()
Indicates to the tool that the DataDescription should be shown to the user, but not allowed to be changed.

Returns:
true if the DataDescription can be changed by the user, or false if it should not be changed.

setReadOnly

void setReadOnly(boolean readOnly)
Sets the DataDescription to be read only.

Parameters:
readOnly - boolean to indicate if the DataDescription should be read only.

setBindingConfigurationName

void setBindingConfigurationName(String bindingConfigName)
Sets the binding configuration name.

Parameters:
bindingConfigName - the configuration name used for this DataBinding in the binding registry.

setName

void setName(QName name)
Sets the name of the global element or complexType that is used as the method argument on the FunctionDescription instance.

Parameters:
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.