|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.etools.sfm.sfpi.SFGenerationProperties
com.ibm.etools.sfm.sfpi.SFChannelGenerationProperties
public class SFChannelGenerationProperties
| 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 |
|---|
public static final java.lang.String ChannelAdapterName
public static final java.lang.String ChannelAdapterTranId
public static final java.lang.String ChannelLinkToProgram
public static final java.lang.String ChannelSysId
public static final java.lang.String ChannelLinkToTranId
public static final java.lang.String ChannelSyncOnReturn
public static final java.lang.String ChannelName
| Method Detail |
|---|
public java.lang.String getInputContainerName(SFMessage inputMessage)
throws SFException
inputMessage - The input message.
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. |
public void setInputContainerProperties(SFMessage inputMessage,
java.lang.String containerName)
throws SFException
inputMessage - The input message.containerName - The container name.
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. |
public java.lang.String getOutputContainerName(SFMessage outputMessage)
throws SFException
outputMessage - The output message.
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. |
public boolean getOutputContainerOptional(SFMessage outputMessage)
throws SFException
outputMessage - The output message.
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. |
public void setOutputContainerProperties(SFMessage outputMessage,
java.lang.String containerName,
boolean optional)
throws SFException
outputMessage - The output message.containerName - The container name.optional - Whether the container is optional.
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. |
public java.lang.String getChannelAdapterName()
public void setChannelAdapterName(java.lang.String adapterName)
throws SFException
adapterName - The adapter name.
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. |
public java.lang.String getChannelAdapterTranId()
public void setChannelAdapterTranId(java.lang.String tranId)
throws SFException
tranId - The transaction id.
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. |
public java.lang.String getChannelLinkToProgram()
public void setChannelLinkToProgram(java.lang.String linkToProgram)
throws SFException
linkToProgram - The program name.
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. |
public java.lang.String getChannelSysId()
public void setChannelSysId(java.lang.String sysId)
throws SFException
sysId - The system id.
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. |
public java.lang.String getChannelLinkToTranId()
public void setChannelLinkToTranId(java.lang.String tranId)
throws SFException
tranId - The transaction id.
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. |
public boolean getChannelSyncOnReturn()
public void setChannelSyncOnReturn(boolean syncOnReturn)
syncOnReturn - Whether to synchronize on return.public java.lang.String getChannelName()
public void setChannelName(java.lang.String name)
throws SFException
name - The channel name.
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. |
public void save(org.eclipse.wst.wsdl.Operation operation)
throws SFException
SFGenerationProperties
save in class SFGenerationPropertiesoperation - The WSDL operation.
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. |
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||