commonj.connector.metadata.discovery
Interface MetadataImportConfiguration


public interface MetadataImportConfiguration

Designates a metadata object and defines properties that are needed to import that metadata object into a service description.

For every metadata object that a tool environment wishes to import, it must create an associated MetadataImportConfiguration and configure its properties according to the desired import parameters.

The content of a MetadataImportConfiguration forms one of the key pieces of information that a tool environment can persist in order to recreate a ServiceDescription. The location value along with the set of configured property values can be used to re-import the associated metadata object, and thus re-create the original ServiceDescription.

Since:
1.0

Method Summary
 void applyConfigurationProperties(PropertyGroup configurationValues)
          Applies the configured property values to the import configuration.
 PropertyGroup createConfigurationProperties()
          Creates a new instance of the properties that will control how the metadata object will be imported.
 String getDescription()
          Gets a description that can be used to convey information from the discovery service to the tool user that may be useful in filling out the properties for this import configuration.
 String getLocation()
          Gets the location of the metadata object that is to be imported.
 

Method Detail

getLocation

String getLocation()
Gets the location of the metadata object that is to be imported. The value returned must be identical to that returned by calling MetadataObject.getLocation()on the associated MetadataObject.

Returns:
a unique non null String representing the location of the associated MetadataObject.
See Also:
MetadataObject.getLocation()

getDescription

String getDescription()
Gets a description that can be used to convey information from the discovery service to the tool user that may be useful in filling out the properties for this import configuration.

The description typically matches that of the associated MetadataObject.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
a non null String description.
See Also:
ResourceBundle, MessageFormat

createConfigurationProperties

PropertyGroup createConfigurationProperties()
Creates a new instance of the properties that will control how the metadata object will be imported.

The value settings of the properties returned must match any values currently applied on the import configuration via a previous call to applyConfigurationProperties(commonj.connector.metadata.discovery.properties.PropertyGroup).

Returns:
a PropertyGroup representing the available configuration properties for the MetadataObject import or null if no configuration properties exist.

applyConfigurationProperties

void applyConfigurationProperties(PropertyGroup configurationValues)
                                  throws MetadataException
Applies the configured property values to the import configuration.

Parameters:
configurationValues - a non null property group that has been configured with values. The property group instance must have been created using the createConfigurationProperties() method.
Throws:
MetadataException - if an error occured during execution. This includes if an invalid PropertyGroup was specified.