StartCode

java.lang.Object
- java.lang.Enum<StartCode>
- - com.ibm.cics.server.StartCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StartCode>
```
public enum StartCode
extends java.lang.Enum<StartCode>
```
Indicates the way that a task has been started.

Since CICS TS version:

6.1

Since package version:

2.0.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DPL_NO_SYNCONRETURN` A distributed program link (DPL) request that did not specify the SYNCONRETURN option.
`DPL_SYNCONRETURN` A distributed program link (DPL) request that did specify the SYNCONRETURN option.
`FEPI_START_COMMAND` FEPI START command.
`START_COMMAND_WITH_DATA` START command that passed data in the FROM option.
`START_COMMAND_WITHOUT_DATA` START command that did not pass data in the FROM option.
`TERMINAL_INPUT` Terminal input or permanent transaction id.
`TRANSIENT_DATA_TRIGGERED` Transient data trigger level.
`USER_ATTACHED` User-attached task.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartCode`	`fromShortCode(java.lang.String shortStartCode)` Turns a string representation of the start code into one of these enumerated values.
`java.lang.String`	`getShortCode()`
`java.lang.String`	`toString()`
`static StartCode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static StartCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DPL_NO_SYNCONRETURN
```
public static final StartCode DPL_NO_SYNCONRETURN
```
    A distributed program link (DPL) request that did not specify the SYNCONRETURN option. This enumeration value equates to the 'D' start code in the CICS documentation. The task cannot issue I/O requests against its principal facility, or any sync point requests.
  - DPL_SYNCONRETURN
```
public static final StartCode DPL_SYNCONRETURN
```
    A distributed program link (DPL) request that did specify the SYNCONRETURN option. This enumeration value equates to the 'DS' start code in the CICS documentation. The task can issue sync point requests.
  - TRANSIENT_DATA_TRIGGERED
```
public static final StartCode TRANSIENT_DATA_TRIGGERED
```
    Transient data trigger level. This enumeration value equates to the 'QD' start code in the CICS documentation.
  - START_COMMAND_WITHOUT_DATA
```
public static final StartCode START_COMMAND_WITHOUT_DATA
```
    START command that did not pass data in the FROM option. It might or might not have passed a channel. This enumeration value equates to the 'S' start code in the CICS documentation.
  - START_COMMAND_WITH_DATA
```
public static final StartCode START_COMMAND_WITH_DATA
```
    START command that passed data in the FROM option. This enumeration value equates to the 'SD' start code in the CICS documentation.
  - FEPI_START_COMMAND
```
public static final StartCode FEPI_START_COMMAND
```
    FEPI START command. This enumeration value equates to the 'SZ' start code in the CICS documentation.
  - TERMINAL_INPUT
```
public static final StartCode TERMINAL_INPUT
```
    Terminal input or permanent transaction id. This enumeration value equates to the 'TD' start code in the CICS documentation.
  - USER_ATTACHED
```
public static final StartCode USER_ATTACHED
```
    User-attached task. This enumeration value equates to the 'U' start code in the CICS documentation.
- Method Detail
  - values
```
public static StartCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (StartCode c : StartCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StartCode valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<StartCode>
    
    Returns:
    
    this object into a simple string.
  - fromShortCode
```
public static StartCode fromShortCode(java.lang.String shortStartCode)
```
    Turns a string representation of the start code into one of these enumerated values.
    
    Parameters:
    
    shortStartCode - The string reason for starting the task. Valid values are: 'D' 'DS' 'QD' 'S' 'SD' 'SZ' 'TD' or 'U' Note: Prior to use, any white space in the shortStartCode is trimmed off. So for example 'D ' is valid input.
    
    Returns:
    
    One of the enumerated values indicating why a task was started.
    
    Throws:
    
    java.lang.RuntimeException - if the string is not one of the recognised codes.
  - getShortCode
```
public java.lang.String getShortCode()
```
    Returns:
    
    The short reason code associated with this enumeration value. The short reason code does not contain space padding.

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

DPL_NO_SYNCONRETURN

DPL_SYNCONRETURN

TRANSIENT_DATA_TRIGGERED

START_COMMAND_WITHOUT_DATA

START_COMMAND_WITH_DATA

FEPI_START_COMMAND

TERMINAL_INPUT

USER_ATTACHED

values

valueOf

toString

fromShortCode

getShortCode