com.adobe.idp.dsc.registry.endpoint
Class CreateEndpointInfo.OutputMapping

java.lang.Object
  com.adobe.idp.dsc.registry.endpoint.CreateEndpointInfo.OutputMapping

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

CreateEndpointInfo

public class CreateEndpointInfo.OutputMapping
extends java.lang.Object
implements java.io.Serializable

Represents an output data mapping value that is associated with an endpoint. An output data mapping describes the output parameter that is returned by the service operation that is invoked by this endpoint.

See Also:

Serialized Form

Constructor Summary

CreateEndpointInfo.OutputMapping()
A standard constructor that creates an OutputMapping object.

CreateEndpointInfo.OutputMapping(java.lang.String aParamName, java.lang.String aDataType, java.lang.String aValue)
A constructor that creates an InputMapping object.

Method Summary

java.lang.String	getParameterName() Retrieves the name of the output parameter.
java.lang.String	getParameterType() Retrieves the data type of the output parameter.
java.lang.String	getValue() Retrieves the output parameter value.
void	setParameterName(java.lang.String aName) Sets the name of the output parameter.
void	setParameterType(java.lang.String aType) Sets the data type of the output parameter.
void	setValue(java.lang.String aValue) Sets the output parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateEndpointInfo.OutputMapping

public CreateEndpointInfo.OutputMapping()

A standard constructor that creates an OutputMapping object.

CreateEndpointInfo.OutputMapping

public CreateEndpointInfo.OutputMapping(java.lang.String aParamName,
                                        java.lang.String aDataType,
                                        java.lang.String aValue)

A constructor that creates an InputMapping object.

Parameters:

aParamName - The name of the output parameter.

aDataType - The data type of the output parameter.

aValue - The following options are available:

• If the service returns a single object (a single document), the pattern is %F.pdf and the source destination is sourcefilename.pdf. For example, the process introduced in this section returns a single document. As a result, the mapping type can be defined as %F.pdf (%F means use the given file name).
• If the service returns a list, the pattern is Result\%F\ and the source destination is Result\sourcefilename\source1 (output 1) and Result\sourcefilename\source2 (output 2).
• If the service returns a map, the pattern is Result\%F\ and the source destination is Result\sourcefilename\file1 and Result\sourcefilename\file2. If there is more than one object in the map, the pattern is Result\%F.pdf and the source destination is Result\sourcefilename1.pdf (output 1), Result\sourcefilenam2.pdf (output 2), and so on.

Method Detail

setParameterName

public void setParameterName(java.lang.String aName)

Sets the name of the output parameter.

Parameters:

aName - The name of the output parameter.

getParameterName

public java.lang.String getParameterName()

Retrieves the name of the output parameter.

Returns:

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

setParameterType

public void setParameterType(java.lang.String aType)

Sets the data type of the output parameter.

Parameters:

aType - The data type of the output parameter.

getParameterType

public java.lang.String getParameterType()

Retrieves the data type of the output parameter.

Returns:

A string value that specifies the output parameter data type.

setValue

public void setValue(java.lang.String aValue)

Sets the output parameter value. The following options are available:

• If the service returns a single object (a single document), the pattern is %F.pdf and the source destination is sourcefilename.pdf. For example, the process introduced in this section returns a single document. As a result, the mapping type can be defined as %F.pdf (%F means use the given file name).
• If the service returns a list, the pattern is Result\%F\ and the source destination is Result\sourcefilename\source1 (output 1) and Result\sourcefilename\source2 (output 2).
• If the service returns a map, the pattern is Result\%F\ and the source destination is Result\sourcefilename\file1 and Result\sourcefilename\file2. If there is more than one object in the map, the pattern is Result\%F.pdf and the source destination is Result\sourcefilename1.pdf (output 1), Result\sourcefilenam2.pdf (output 2), and so on.

Parameters:

aValue - The output parameter value.

getValue

public java.lang.String getValue()

Retrieves the output parameter value.

Returns:

A string value that specifies the output parameter name.