com.ibm.etools.sfm.sfpi
Class SFCommareaGenerationProperties

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

public class SFCommareaGenerationProperties
extends SFGenerationProperties

SFCommareaGenerationProperties is an implementation of SFGenerationProperties that represents the generation properties for a COMMAREA operation.


Field Summary
static java.lang.String CommareaAdapterName
          The COMMAREA adapter name property.
static java.lang.String CommareaAdapterTranId
          The COMMAREA adapter transaction id property.
static java.lang.String CommareaLinkToProgram
          The COMMAREA LINK to program name property.
static java.lang.String CommareaLinkToTranId
          The COMMAREA LINK to transaction id property.
static java.lang.String CommareaMaxLength
          The COMMAREA maximum COMMAREA length property.
static java.lang.String CommareaSyncOnReturn
          The COMMAREA syncpoint on return property.
static java.lang.String CommareaSysId
          The COMMAREA 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 getCommareaAdapterName()
           
 java.lang.String getCommareaAdapterTranId()
           
 java.lang.String getCommareaLinkToProgram()
           
 java.lang.String getCommareaLinkToTranId()
           
 int getCommareaMaxLength()
           
 boolean getCommareaSyncOnReturn()
           
 java.lang.String getCommareaSysId()
           
 void setCommareaAdapterName(java.lang.String adapterName)
          Sets the value of the COMMAREA adapter name property.
 void setCommareaAdapterTranId(java.lang.String tranId)
          Sets the value of the COMMAREA transaction id property.
 void setCommareaLinkToProgram(java.lang.String linkToProgram)
          Sets the value of the COMMAREA LINK to program name property.
 void setCommareaLinkToTranId(java.lang.String tranId)
          Sets the value of the COMMAREA LINK to transaction id property.
 void setCommareaMaxLength(int maxLength)
          Sets the value of the COMMAREA maximum COMMAREA length property.
 void setCommareaSyncOnReturn(boolean syncOnReturn)
          Sets the value of the COMMAREA syncpoint on return property.
 void setCommareaSysId(java.lang.String sysId)
          Sets the value of the COMMAREA system id property.
 
Methods inherited from class com.ibm.etools.sfm.sfpi.SFGenerationProperties
getInvokeType, getRuntime, save, setRuntime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CommareaAdapterName

public static final java.lang.String CommareaAdapterName
The COMMAREA adapter name property.

See Also:
Constant Field Values

CommareaAdapterTranId

public static final java.lang.String CommareaAdapterTranId
The COMMAREA adapter transaction id property.

See Also:
Constant Field Values

CommareaMaxLength

public static final java.lang.String CommareaMaxLength
The COMMAREA maximum COMMAREA length property.

See Also:
Constant Field Values

CommareaLinkToProgram

public static final java.lang.String CommareaLinkToProgram
The COMMAREA LINK to program name property.

See Also:
Constant Field Values

CommareaSysId

public static final java.lang.String CommareaSysId
The COMMAREA system id property.

See Also:
Constant Field Values

CommareaLinkToTranId

public static final java.lang.String CommareaLinkToTranId
The COMMAREA LINK to transaction id property.

See Also:
Constant Field Values

CommareaSyncOnReturn

public static final java.lang.String CommareaSyncOnReturn
The COMMAREA syncpoint on return property.

See Also:
Constant Field Values
Method Detail

getCommareaAdapterName

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

setCommareaAdapterName

public void setCommareaAdapterName(java.lang.String adapterName)
                            throws SFException
Sets the value of the COMMAREA adapter name property. The given transaction id 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.

getCommareaAdapterTranId

public java.lang.String getCommareaAdapterTranId()
Returns:
The value of the COMMAREA adapter transaction id property.

setCommareaAdapterTranId

public void setCommareaAdapterTranId(java.lang.String tranId)
                              throws SFException
Sets the value of the COMMAREA transaction id property. The given transaction id 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.

getCommareaMaxLength

public int getCommareaMaxLength()
Returns:
The value of the COMMAREA maximum COMMAREA length property.

setCommareaMaxLength

public void setCommareaMaxLength(int maxLength)
                          throws SFException
Sets the value of the COMMAREA maximum COMMAREA length property.

Parameters:
maxLength - The maximum COMMAREA length.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The maxLength is less than 0. ERROR: The maimum COMMAREA length was not set successfully.

getCommareaLinkToProgram

public java.lang.String getCommareaLinkToProgram()
Returns:
The value of the COMMAREA LINK to program name property.

setCommareaLinkToProgram

public void setCommareaLinkToProgram(java.lang.String linkToProgram)
                              throws SFException
Sets the value of the COMMAREA LINK to program name property. The given transaction id 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.

getCommareaSysId

public java.lang.String getCommareaSysId()
Returns:
The value of the COMMAREA system id property.

setCommareaSysId

public void setCommareaSysId(java.lang.String sysId)
                      throws SFException
Sets the value of the COMMAREA system id property. The given transaction id is truncated to 4 characters and capitalized.

Parameters:
sysId - The transaction 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.

getCommareaLinkToTranId

public java.lang.String getCommareaLinkToTranId()
Returns:
The value of the COMMAREA LINK to transaction id property.

setCommareaLinkToTranId

public void setCommareaLinkToTranId(java.lang.String tranId)
                             throws SFException
Sets the value of the COMMAREA LINK to transaction id property. The given transaction id 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 LINK to 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 LINK to transaction id was not set successfully.

getCommareaSyncOnReturn

public boolean getCommareaSyncOnReturn()
Returns:
The value of the COMMAREA syncpoint on return property.

setCommareaSyncOnReturn

public void setCommareaSyncOnReturn(boolean syncOnReturn)
Sets the value of the COMMAREA syncpoint on return property.

Parameters:
syncOnReturn - Whether to synchronize on return.