com.ibm.etools.sfm.sfpi
Class SFGenerationProperties

java.lang.Object
  extended by com.ibm.etools.sfm.sfpi.SFGenerationProperties
Direct Known Subclasses:
SFChannelGenerationProperties, SFCommareaGenerationProperties, SFMQSeriesGenerationProperties

public abstract class SFGenerationProperties
extends java.lang.Object

The SFGenerationProperties class is an abstract class that represents the base generation properties for an operation.


Field Summary
static java.lang.String InvokeType
          The invoke type property.
static java.lang.String InvokeType_Channel
          The invoke type value for a Channel operation.
static java.lang.String InvokeType_COMMAREA
          The invoke type value for a COMMAREA operation.
static java.lang.String InvokeType_MQSeries
          The invoke type value for an MQ Series operation.
static java.lang.String Runtime
          The runtime property.
static java.lang.String Runtime_CSFR31
          The runtime value for Service Flow Runtime for CICS TS 3.1.
static java.lang.String Runtime_CSFR32
          The runtime value for Service Flow Runtime for CICS TS 3.2.
 
Method Summary
 java.lang.String getInvokeType()
           
 java.lang.String getRuntime()
           
 void save(org.eclipse.wst.wsdl.Operation operation)
          Saves the generation properties to a documentation element within the given WSDL operation.
 void setRuntime(java.lang.String runtime)
          Sets the runtime of the associated operation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Runtime

public static final java.lang.String Runtime
The runtime property. The value of this property should be one of the Runtime_CSFR31 and Runtime CSFR32.

See Also:
Constant Field Values

Runtime_CSFR31

public static final java.lang.String Runtime_CSFR31
The runtime value for Service Flow Runtime for CICS TS 3.1.

See Also:
Constant Field Values

Runtime_CSFR32

public static final java.lang.String Runtime_CSFR32
The runtime value for Service Flow Runtime for CICS TS 3.2.

See Also:
Constant Field Values

InvokeType

public static final java.lang.String InvokeType
The invoke type property. The value of this property should be one of InvokeType_COMMAREA, InvokeType_Channel, and InvokeType_MQSeries.

See Also:
Constant Field Values

InvokeType_COMMAREA

public static final java.lang.String InvokeType_COMMAREA
The invoke type value for a COMMAREA operation.

See Also:
Constant Field Values

InvokeType_Channel

public static final java.lang.String InvokeType_Channel
The invoke type value for a Channel operation.

See Also:
Constant Field Values

InvokeType_MQSeries

public static final java.lang.String InvokeType_MQSeries
The invoke type value for an MQ Series operation.

See Also:
Constant Field Values
Method Detail

getRuntime

public java.lang.String getRuntime()
Returns:
The runtime of the associated operation.

setRuntime

public void setRuntime(java.lang.String runtime)
                throws SFException
Sets the runtime of the associated operation.

Parameters:
runtime - The runtime.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The runtime is null. ERROR: The runtime was not set successfully.
WZEF1401E_RUNTIMENOTVALID The runtime is not valid. The runtime must be one of Runtime_CSFR31 and Runtime_CSFR32. ERROR: The runtime was not set successfully.
WZEF1402E_RUNTIMENOTSUPPORTED The given runtime is not supported for the invoke type. ERROR: The runtime was not set successfully.

getInvokeType

public java.lang.String getInvokeType()
Returns:
The invoke type of the associated operation.

save

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

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.