com.adobe.idp.dsc.registry.infomodel
Interface OutputParameterMapping

All Superinterfaces:

Serializable

public interface OutputParameterMapping
extends Serializable

This interface defines the output data mapping of a connector endpoint. It describes the data type that a connector supports, as well as how to map the connector data into the target service's operation argument.

If the mapping type is a variable mapping type, the value of the output data mapping would be the XPath expression of the connector variable.

Field Summary

static String	COLLECTION_ATTRIBUTE Represents a collection attribute.
static String	VARIABLE_MAPPING_ATTRIBUTE Represents a variable attribute.

Method Summary

Map	getAttributes() Retrieves the attributes or metadata specific to this endpoint's connector.
String	getMappingValue() Returns the mapping value of this parameter mapping.
String	getOutputParameterName() Retrieves the operation's output parameter name.
PropertyEditor	getPropertyEditor() Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent to use for editing or viewing this parameter data mapping.
String	getPropertyEditorId() Retrieves a PropertyEditor identifier value that references a PropertyEditorComponent to use for editing or viewing of this parameter data mapping.
String	getType() Retrieves the data type for this parameter.

Field Detail

COLLECTION_ATTRIBUTE

static final String COLLECTION_ATTRIBUTE

Represents a collection attribute.

See Also:

Constant Field Values

VARIABLE_MAPPING_ATTRIBUTE

static final String VARIABLE_MAPPING_ATTRIBUTE

Represents a variable attribute.

See Also:

Constant Field Values

Method Detail

getOutputParameterName

String getOutputParameterName()

Retrieves the operation's output parameter name.

Returns:

A string value that specifies the operation's output parameter name.

getType

String getType()

Retrieves the data type for this parameter.

Returns:

A string value that specifies the data type of this parameter.

getAttributes

Map getAttributes()

Retrieves the attributes or metadata specific to this endpoint's connector.

Returns:

A java.util.Map containing the attributes or metadata specific to this endpoint's connector.

getMappingValue

String getMappingValue()

Returns the mapping value of this parameter mapping.

Returns:

A string value that represents the mapping value.

getPropertyEditorId

String getPropertyEditorId()

Retrieves a PropertyEditor identifier value that references a PropertyEditorComponent to use for editing or viewing of this parameter data mapping.

Returns:

A string value that represents the identifer value of a PropertyEditor object A property editor identifier.

getPropertyEditor

PropertyEditor getPropertyEditor()

Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent to use for editing or viewing this parameter data mapping.

Returns:

A PropertyEditor object that is used to edit or view this parameter data mapping.