org.eclipse.wst.common.frameworks.datamodel
Interface IDataModelProperties

All Known Subinterfaces:
IDataModelProvider
All Known Implementing Classes:
AbstractDataModelProvider

public interface IDataModelProperties

IDataModelProperties provides the base interface for all Data Model Properties interfaces. Sub interface classes (e.g. some.company.IFooDataModelProperties.class) should be used to create instances of IDataModels using the DataModelFactory.createDataModel(Class) method. In order for this mechanism to work, the backing IDataModelProvider class must be registerd to support the sub IDataModelProperties interface in one of two ways. This registration should be performed by the model developer.

The first way to register the correct IDataModelProvider class is for the interface to define a public static Class _provider_class field which is set to the IDataModelProvider class, e.g.

public static final Class _provider_class = some.company.FooDataModelProvider.class

The above mechanism is recommended whenever the IDataModelProperties and IDataModelProvider classes are both defined in the same plugin scope. A second mechanism using the DataModelProviderExtension extension point is available when the IDataModelProvider class is definend outside the IDataModelProperties plugin scope.

This interface is not intended to be implemented by clients.

Since:
1.0
See Also:
IDataModelProvider, DataModelFactory

Field Summary
static java.lang.String ALLOW_EXTENSIONS
          A boolean property defaults to Boolean.TRUE.
static java.lang.String RESTRICT_EXTENSIONS
          A List containing String objects, defautls to an empty List.
 

Field Detail

ALLOW_EXTENSIONS

static final java.lang.String ALLOW_EXTENSIONS
A boolean property defaults to Boolean.TRUE. If this is set to Boolean.FALSE no extended operations will be executed.

See Also:
Constant Field Values

RESTRICT_EXTENSIONS

static final java.lang.String RESTRICT_EXTENSIONS
A List containing String objects, defautls to an empty List. If this list contains elements and ALLOW_EXTENSIONS is set to Boolean.TRUE, then only extended operations not identified in this list will be executed. These strings should either be the operation id or the fully qualified operation class name.

See Also:
Constant Field Values