com.ibm.etools.sfm.sfpi
Class SFChannelGenerationProperties

java.lang.Object
  extended by com.ibm.etools.sfm.sfpi.SFGenerationProperties
      extended by com.ibm.etools.sfm.sfpi.SFChannelGenerationProperties

public class SFChannelGenerationProperties
extends SFGenerationProperties


Field Summary
static java.lang.String ChannelAdapterName
          The Channel adapter name property.
static java.lang.String ChannelAdapterTranId
          The Channel adapter transaction id property.
static java.lang.String ChannelLinkToProgram
          The Channel LINK to program name property.
static java.lang.String ChannelLinkToTranId
          The Channel LINK to transaction id property.
static java.lang.String ChannelName
          The Channel name property.
static java.lang.String ChannelSyncOnReturn
          The Channel synchronize on return property.
static java.lang.String ChannelSysId
          The Channel system id property.
 
Fields inherited from class com.ibm.etools.sfm.sfpi.SFGenerationProperties
InvokeType, InvokeType_Channel, InvokeType_COMMAREA, InvokeType_MQSeries, Runtime, Runtime_CSFR31, Runtime_CSFR32
 
Method Summary
 java.lang.String getChannelAdapterName()
           
 java.lang.String getChannelAdapterTranId()
           
 java.lang.String getChannelLinkToProgram()
           
 java.lang.String getChannelLinkToTranId()
           
 java.lang.String getChannelName()
           
 boolean getChannelSyncOnReturn()
           
 java.lang.String getChannelSysId()
           
 java.lang.String getInputContainerName(SFMessage inputMessage)
          Gets the input container name set for the given input message.
 java.lang.String getOutputContainerName(SFMessage outputMessage)
          Gets the output container name set for the given output message.
 boolean getOutputContainerOptional(SFMessage outputMessage)
          Gets the optional setting for the given output message.
 void save(org.eclipse.wst.wsdl.Operation operation)
          Saves the generation properties to a documentation element within the given WSDL operation.
 void setChannelAdapterName(java.lang.String adapterName)
          Sets the value of the Channel adapter name property.
 void setChannelAdapterTranId(java.lang.String tranId)
          Sets the value of the Channel adapter transaction id property.
 void setChannelLinkToProgram(java.lang.String linkToProgram)
          Sets the value of the Channel link to program name property.
 void setChannelLinkToTranId(java.lang.String tranId)
          Sets the value of the Channel link to transaction id property.
 void setChannelName(java.lang.String name)
          Sets the value of the Channel name property.
 void setChannelSyncOnReturn(boolean syncOnReturn)
          Sets the value of the Channel synchronize on return property.
 void setChannelSysId(java.lang.String sysId)
          Sets the value of the Channel system id property.
 void setInputContainerProperties(SFMessage inputMessage, java.lang.String containerName)
          Sets the container properties for the given input message.
 void setOutputContainerProperties(SFMessage outputMessage, java.lang.String containerName, boolean optional)
          Sets the container properties for the given output message.
 
Methods inherited from class com.ibm.etools.sfm.sfpi.SFGenerationProperties
getInvokeType, getRuntime, setRuntime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ChannelAdapterName

public static final java.lang.String ChannelAdapterName
The Channel adapter name property.

See Also:
Constant Field Values

ChannelAdapterTranId

public static final java.lang.String ChannelAdapterTranId
The Channel adapter transaction id property.

See Also:
Constant Field Values

ChannelLinkToProgram

public static final java.lang.String ChannelLinkToProgram
The Channel LINK to program name property.

See Also:
Constant Field Values

ChannelSysId

public static final java.lang.String ChannelSysId
The Channel system id property.

See Also:
Constant Field Values

ChannelLinkToTranId

public static final java.lang.String ChannelLinkToTranId
The Channel LINK to transaction id property.

See Also:
Constant Field Values

ChannelSyncOnReturn

public static final java.lang.String ChannelSyncOnReturn
The Channel synchronize on return property.

See Also:
Constant Field Values

ChannelName

public static final java.lang.String ChannelName
The Channel name property.

See Also:
Constant Field Values
Method Detail

getInputContainerName

public java.lang.String getInputContainerName(SFMessage inputMessage)
                                       throws SFException
Gets the input container name set for the given input message.

Parameters:
inputMessage - The input message.
Returns:
The container name set for the given input message.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The inputMessage is null. ERROR: The container name was not retrieved successfully.
WZEF1403E_INPUTMESSAGENOTFOUND An attempt to access or modify the container properties of a message that is not an input message of the associated channel operation was detected. ERROR: The container name was not retrieved successfully.

setInputContainerProperties

public void setInputContainerProperties(SFMessage inputMessage,
                                        java.lang.String containerName)
                                 throws SFException
Sets the container properties for the given input message. The container name is truncated to the first 16 characters and capitalized.

Parameters:
inputMessage - The input message.
containerName - The container name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The inputMessage or containerName is null. ERROR: The container properties were not set successfully.
WZEF1403E_INPUTMESSAGENOTFOUND An attempt to access or modify the container properties of a message that is not an input message of the associated channel operation was detected. ERROR: The container properties were not set successfully.
WZEF1405E_RESTRICTEDCONTAINERNAME The container name is not allowed. The container name must not be one of "ADAPTER.PROCESS", "ADAPTER.ERROR", "COMMAND.STATUS", "COMMAND.INPUT", "COMMAND.OUTPUT", or "DPL.DATA". ERROR: The container properties were not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The container properties were not set successfully.

getOutputContainerName

public java.lang.String getOutputContainerName(SFMessage outputMessage)
                                        throws SFException
Gets the output container name set for the given output message.

Parameters:
outputMessage - The output message.
Returns:
The container name set for the given output message.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The outputMessage is null. ERROR: The container name was not retrieved successfully.
WZEF1404E_OUTPUTMESSAGENOTFOUND An attempt to access or modify the container properties of a message that is not an output message of the associated channel operation was detected. ERROR: The container name was not retrieved successfully.

getOutputContainerOptional

public boolean getOutputContainerOptional(SFMessage outputMessage)
                                   throws SFException
Gets the optional setting for the given output message.

Parameters:
outputMessage - The output message.
Returns:
The optional setting for the given output message.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The outputMessage is null. ERROR: The optional setting was not retrieved successfully.
WZEF1404E_OUTPUTMESSAGENOTFOUND An attempt to access or modify the container properties of a message that is not an output message of the associated channel operation was detected. ERROR: The optional setting was not retrieved successfully.

setOutputContainerProperties

public void setOutputContainerProperties(SFMessage outputMessage,
                                         java.lang.String containerName,
                                         boolean optional)
                                  throws SFException
Sets the container properties for the given output message. The container name is truncated to the first 16 characters and capitalized.

Parameters:
outputMessage - The output message.
containerName - The container name.
optional - Whether the container is optional.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The outputMessage or containerName is null. ERROR: The container properties were not set successfully.
WZEF1404E_OUTPUTMESSAGENOTFOUND An attempt to access or modify the container properties of a message that is not an output message of the associated channel operation was detected. ERROR: The container properties were not set successfully.
WZEF1405E_RESTRICTEDCONTAINERNAME The container name is not allowed. The container name must not be one of "ADAPTER.PROCESS", "ADAPTER.ERROR", "COMMAND.STATUS", "COMMAND.INPUT", "COMMAND.OUTPUT", or "DPL.DATA". ERROR: The container properties were not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The container properties were not set successfully.

getChannelAdapterName

public java.lang.String getChannelAdapterName()
Returns:
The value of the Channel adapter name property.

setChannelAdapterName

public void setChannelAdapterName(java.lang.String adapterName)
                           throws SFException
Sets the value of the Channel adapter name property. The given channel name is truncated to 8 characters and capitalized.

Parameters:
adapterName - The adapter name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The adapterName is null. ERROR: The adapter name was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The adapter name was not set successfully.

getChannelAdapterTranId

public java.lang.String getChannelAdapterTranId()
Returns:
The value of the Channel adapter name property.

setChannelAdapterTranId

public void setChannelAdapterTranId(java.lang.String tranId)
                             throws SFException
Sets the value of the Channel adapter transaction id property. The given channel name is truncated to 4 characters and capitalized.

Parameters:
tranId - The transaction id.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The tranId is null. ERROR: The transaction id was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The transaction id was not set successfully.

getChannelLinkToProgram

public java.lang.String getChannelLinkToProgram()
Returns:
The value of the Channel adapter name property.

setChannelLinkToProgram

public void setChannelLinkToProgram(java.lang.String linkToProgram)
                             throws SFException
Sets the value of the Channel link to program name property. The given channel name is truncated to 8 characters and capitalized.

Parameters:
linkToProgram - The program name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The linkToProgram is null. ERROR: The link to program name was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The link to program name was not set successfully.

getChannelSysId

public java.lang.String getChannelSysId()
Returns:
The value of the Channel adapter name property.

setChannelSysId

public void setChannelSysId(java.lang.String sysId)
                     throws SFException
Sets the value of the Channel system id property. The given channel name is truncated to 4 characters and capitalized.

Parameters:
sysId - The system id.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The sysId is null. ERROR: The system id was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The system id was not set successfully.

getChannelLinkToTranId

public java.lang.String getChannelLinkToTranId()
Returns:
The value of the Channel adapter name property.

setChannelLinkToTranId

public void setChannelLinkToTranId(java.lang.String tranId)
                            throws SFException
Sets the value of the Channel link to transaction id property. The given channel name is truncated to 4 characters and capitalized.

Parameters:
tranId - The transaction id.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The tranId is null. ERROR: The transaction id was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The transaction id was not set successfully.

getChannelSyncOnReturn

public boolean getChannelSyncOnReturn()
Returns:
The value of the Channel adapter name property.

setChannelSyncOnReturn

public void setChannelSyncOnReturn(boolean syncOnReturn)
Sets the value of the Channel synchronize on return property.

Parameters:
syncOnReturn - Whether to synchronize on return.

getChannelName

public java.lang.String getChannelName()
Returns:
The value of the Channel adapter name property.

setChannelName

public void setChannelName(java.lang.String name)
                    throws SFException
Sets the value of the Channel name property. The given channel name is truncated to 16 characters and capitalized.

Parameters:
name - The channel name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The name is null. ERROR: The Channel name was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The Channel name was not set successfully.

save

public void save(org.eclipse.wst.wsdl.Operation operation)
          throws SFException
Description copied from class: SFGenerationProperties
Saves the generation properties to a documentation element within the given WSDL operation. This method is called by the SFOperationsFile.save() method.

Overrides:
save in class SFGenerationProperties
Parameters:
operation - The WSDL operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The operation is null. ERROR: The generation properties were not saved successfully.
WZEF1401E_RUNTIMENOTVALID The runtime is not valid. The runtime must be one of Runtime_CSFR31 and Runtime_CSFR32. ERROR: The generation properties were not saved successfully.