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

All Superinterfaces:

java.io.Serializable

public interface InputParameterMapping
extends java.io.Serializable

Defines the input data mapping, including data type values, that an endpoint supports. Consider a Wateched Folder endpoint. When creating a Watched Folder endpoint, you must describe the input values that are passed to the operation that is invoked by the Watched Folder. To describe the input values, you use an InputParameterMapping instance.

If the mapping type is a value type, the value of the input data mapping is the mapping itself.

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

The name of the input data mapping is identical to the name of the connector variable. For information about programmatically creating a Watched Folder endpoint, see Adding Watched Folder Endpoints in the LiveCycle SDK Help.

Field Summary

static java.lang.String	COLLECTION_ATTRIBUTE Represents the collection attribute.
static java.lang.String	RECEIVER_PARAMETER_NAME Represents the receiver parameter name attribute.
static java.lang.String	VALUE_MAPPING_ATTRIBUTE Represents the constant attribute.
static java.lang.String	VARIABLE_MAPPING_ATTRIBUTE Represents the variable attribute.

Method Summary

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

Field Detail

COLLECTION_ATTRIBUTE

static final java.lang.String COLLECTION_ATTRIBUTE

Represents the collection attribute.

See Also:

Constant Field Values

VARIABLE_MAPPING_ATTRIBUTE

static final java.lang.String VARIABLE_MAPPING_ATTRIBUTE

Represents the variable attribute.

See Also:

Constant Field Values

VALUE_MAPPING_ATTRIBUTE

static final java.lang.String VALUE_MAPPING_ATTRIBUTE

Represents the constant attribute.

See Also:

Constant Field Values

RECEIVER_PARAMETER_NAME

static final java.lang.String RECEIVER_PARAMETER_NAME

Represents the receiver parameter name attribute.

See Also:

Constant Field Values

Method Detail

getInputParameterName

java.lang.String getInputParameterName()

Retrieves the operation's input parameter name.

Returns:

A string value that represents the input parameter name that belongs to the operation.

getType

java.lang.String getType()

Retrieves the data type of this parameter.

Returns:

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

getMappingType

java.lang.String getMappingType()

Retrieves the mapping type for this endpoint.

Returns:

A string value that specifies value or variable. If value is returned, the mapping value is the real value.

getMappingValue

java.lang.String getMappingValue()

Retrieves the mapping value of this parameter mapping.

Returns:

The mapping value of this parameter mapping.

getAttributes

java.util.Map getAttributes()

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

Returns:

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

getPropertyEditorId

java.lang.String getPropertyEditorId()

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

Returns:

A string value that specifies the property editor identifier value.

getPropertyEditor

PropertyEditor getPropertyEditor()

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

Returns:

A PropertyEditor instance.