com.adobe.idp.dsc.registry.endpoint
Class ModifyEndpointInfo.InputMapping

java.lang.Object
  com.adobe.idp.dsc.registry.endpoint.ModifyEndpointInfo.InputMapping

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ModifyEndpointInfo

public class ModifyEndpointInfo.InputMapping
extends java.lang.Object
implements java.io.Serializable

Represents an input data mapping value that is assoicated with an endpoint. An input data mapping describes the input values that are passed to the service operation invoked by this endpoint. For information about setting input data mapping values, see Managing Endpoints in the LiveCycle SDK Help.

See Also:

Serialized Form

Constructor Summary

ModifyEndpointInfo.InputMapping()
A standard constructor that creates an InputMapping object.

ModifyEndpointInfo.InputMapping(java.lang.String aParamName, java.lang.String aParamType, java.lang.String aType, java.lang.String aValue)
A constructor that creates an InputMapping object.

Method Summary

java.lang.String	getParameterName() Retrieves the name of the input parameter.
java.lang.String	getParameterType() Retrieves the data type of the input parameter.
java.lang.String	getType() Sets the input values required to invoke the service operation.
java.lang.String	getValue() Retrieves the value of the mapping type.
void	setParameterName(java.lang.String aName) Sets the name of the input parameter.
void	setParameterType(java.lang.String aName) Sets the data type of the input parameter.
void	setType(java.lang.String aType) Sets the input values required to invoke the service operation.
void	setValue(java.lang.String aValue) Specifies the value of the mapping type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModifyEndpointInfo.InputMapping

public ModifyEndpointInfo.InputMapping()

A standard constructor that creates an InputMapping object.

ModifyEndpointInfo.InputMapping

public ModifyEndpointInfo.InputMapping(java.lang.String aParamName,
                                       java.lang.String aParamType,
                                       java.lang.String aType,
                                       java.lang.String aValue)

A constructor that creates an InputMapping object.

Parameters:

aParamName - The name of the input parameter.

aParamType - The data type of the input parameter.

aType - Used to configure the input values required to invoke the service operation. Two types of mapping types exist:

• Literal:An endpoint uses the value entered in the field as it is displayed. All basic Java types are supported. For example, if an API uses input such as String, long, int, and Boolean then the string is converted into the proper type and the service is invoked.
• Variable: The value entered is a file pattern that the endpoint uses to pick the input. For example, if you select Variable for the mapping type and the input document has to be a PDF file, you can specify *.pdf as the mapping value.

aValue - Specifies the value of the mapping type. For example, if you select a Variable mapping type, then you can specify *.pdf as the file pattern.

Method Detail

setParameterName

public void setParameterName(java.lang.String aName)

Sets the name of the input parameter.

Parameters:

aName - The name of the input parameter.

getParameterName

public java.lang.String getParameterName()

Retrieves the name of the input parameter.

Returns:

A string value that specifies the name of the input parameter.

setParameterType

public void setParameterType(java.lang.String aName)

Sets the data type of the input parameter.

Parameters:

aName - The data type of the input parameter.

getParameterType

public java.lang.String getParameterType()

Retrieves the data type of the input parameter.

Returns:

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

setType

public void setType(java.lang.String aType)

Sets the input values required to invoke the service operation. Two types of mapping types exist:

• Literal:An endpoint uses the value entered in the field as it is displayed. All basic Java types are supported. For example, if an API uses input such as String, long, int, and Boolean then the string is converted into the proper type and the service is invoked.
• Variable: The value entered is a file pattern that the endpoint uses to pick the input. For example, if you select Variable for the mapping type and the input document has to be a PDF file, you can specify *.pdf as the mapping value.

Parameters:

aType - The mapping type value.

getType

public java.lang.String getType()

Sets the input values required to invoke the service operation. Two types of mapping types exist:

• Literal:An endpoint uses the value entered in the field as it is displayed. All basic Java types are supported. For example, if an API uses input such as String, long, int, and Boolean then the string is converted into the proper type and the service is invoked.
• Variable: The value entered is a file pattern that the endpoint uses to pick the input. For example, if you select Variable for the mapping type and the input document has to be a PDF file, you can specify *.pdf as the mapping value.

Returns:

A string value that specifies the mappping type value.

setValue

public void setValue(java.lang.String aValue)

Specifies the value of the mapping type.

Parameters:

aValue - Specifies the value of the mapping type. For example, if you select a Variable mapping type, then you can specify *.pdf as the file pattern.

getValue

public java.lang.String getValue()

Retrieves the value of the mapping type.

Returns:

A string value that specifies the mapping type value.