commonj.connector.metadata
Interface BindingConfigurationEdit


public interface BindingConfigurationEdit

A mix in interface that can be used with a FunctionSelector, DataBinding or DataHandler for configuring binding properties in tooling.

The fully qualified name of an implementation class must follow a naming pattern. The name must match the name of the FunctionSelector, DataBinding, or DataHandler it is to be used with, plus the suffix "Configuration". For example, the EditBindingConfiguration implementation class for configuring xyz.MyDataBinding is xyz.MyDataBindingConfiguration.

The Java Bean that represents the binding properties for a DataBinding, DataHandler or FunctionSelector also follows a naming pattern. It must match the fully qualified class name of the FunctionSelector, DataBinding, or DataHandler plus the suffix "Properties". For example the binding properties Java Bean for xyz.MyDataBinding is xyz.MyDataBindingProperties.

Since:
1.1
See Also:
FunctionSelector, DataBinding

Method Summary
 EditableType getEditableType()
          Returns the EditableType that can be used by the tool to edit the binding properties.
 boolean isOptional()
          Return true if the DataBinding, DataHandler, or FunctionSelector does not need to be configured before use, otherwise return false.
 void setType(URI filename, QName name)
          This should be set prior to calling getEditableType.
 

Method Detail

getEditableType

EditableType getEditableType()
Returns the EditableType that can be used by the tool to edit the binding properties. If null is returned then the tool works directly with the Property JavaBean.

Returns:
EditableType that can be used by the tool to edit the binding properites or null.
See Also:
EditableType

setType

void setType(URI filename,
             QName name)
             throws MetadataException
This should be set prior to calling getEditableType. and is used when the DataBinding may be wrapping other DataBinding instances.

If the BindingConfiguration is being edited outside the scope of function description then the type may not be known, and cannot be set by tooling.

If this DataBinding does not support this type then it can raise exception.

Parameters:
filename - is the absolute URI specifying the location of the schema.
name - is the name of the global element or complex type.
Throws:
MetadataException - when this DataBinding or FunctionSelector does not support the specified type.

isOptional

boolean isOptional()
Return true if the DataBinding, DataHandler, or FunctionSelector does not need to be configured before use, otherwise return false.

Returns:
true if the BindingConfiguration is optional, otherwise false.