DLICall.Function

java.lang.Object
- java.lang.Enum<DLICall.Function>
- - com.ibm.ims.dli.DLICall.Function

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DLICall.Function>

Enclosing interface:

DLICall
```
public static enum DLICall.Function
extends java.lang.Enum<DLICall.Function>
```
The constants that represent the IMS DL/I call functions.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTH` An Authorization (AUTH) call verifies each user's security authorization.
`DEQ` The Dequeue (DEQ) call is used to release a segment that is retrieved using the Q command code.
`FLD` The Field (FLD) call is used to access a field within a segment for MSDBs or DEDBs.
`GMSG` A Get Message (GMSG) call is used in an automated operator (AO) application program to retrieve a message from AO exit routine DFSAOE00.
`ICMD` An Issue Command (ICMD) call lets an automated operator (AO) application program issue an IMS command and retrieve the first command response segment.
`INIT` An Initialize (INIT) call allows the application to receive data availability status codes by checking each DB PCB for data availability.
`INQY` The Inquiry (INQY) call is used to request information regarding execution environment, destination type and status, and session status.
`LOG` The Log (LOG) call is used to send and write information to the IMS system log.
`RCMD` A Retrieve Command (RCMD) call enables an automated operator (AO) application program retrieve the second and subsequent command response segments after an ICMD call.
`RLSE` The Release Locks (RLSE) call is used to release all locks held for unmodified data.
`ROLL` The Roll (ROLL) call backs out output messages sent by a conversational application program and terminates the conversation.
`ROLS` The Roll Back to SETS/SETU (ROLS) call returns message queue positions to sync points established by the SETS/SETU call.
`SETS` The Set Backout Point (SETS) call is used to set an intermediate backout point or to cancel all existing backout points.
`SETU` The Set Unconditional (SETU) call operates like the SETS call except that the SETU call isn't rejected if unsupported PCBs are in the PSB or if the program uses an external subsystem.
`STAT` The Statistics (STAT) call is used in a CICS, IMS online, or batch program to obtain database statistics that might be useful for performance monitoring.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DLICall.Function`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DLICall.Function[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - AUTH
```
public static final DLICall.Function AUTH
```
    An Authorization (AUTH) call verifies each user's security authorization. It determines whether a user is authorized to access the resources specified on the AUTH call.
    The following code example shows how to issue an AUTH call:
    try { props = new DLICallProperty(DLICall.Function.AUTH); props.put(DLICallProperty.Property.CLASSNAME, DLICallProperty.Classname.FIELD); props.put(DLICallProperty.Property.RESOURCE, "abcd"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); AUTHCallResult result = (AUTHCallResult) dliCall.execute(); short feedback = result.getFeedback()); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I AUTH call, see the topic AUTH call in the IMS Application Programming APIs reference documentation.
  - DEQ
```
public static final DLICall.Function DEQ
```
    The Dequeue (DEQ) call is used to release a segment that is retrieved using the Q command code.
    The following code example shows how to issue a DEQ call:
    try { props = new DLICallProperty(DLICall.Function.DEQ); props.put(DLICallProperty.Property.LOCK_CLASS, DLICallProperty.LockClass.A); DLICall dliCall = psb.prepareIMSRegionDLICall(props); DLICallResult result = dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I DEQ call, see the topic DEQ call in the IMS Application Programming APIs reference documentation.
  - GMSG
```
public static final DLICall.Function GMSG
```
    A Get Message (GMSG) call is used in an automated operator (AO) application program to retrieve a message from AO exit routine DFSAOE00.
    The following code example shows how to issue a GMSG call:
    try { props = new DLICallProperty(DLICall.Function.GMSG); props.put(DLICallProperty.Property.AIB_SUB_FUNCTION_CODE, DLICallProperty.Subfunction.WAITAOI); props.put(DLICallProperty.Property.AOI_TOKEN, "XYZ"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); GMSGCallResult result = (GMSGCallResult) dliCall.execute(); String message = result.getMessage(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I GMSG call, see the topic GMSG call in the IMS Application Programming APIs reference documentation.
  - ICMD
```
public static final DLICall.Function ICMD
```
    An Issue Command (ICMD) call lets an automated operator (AO) application program issue an IMS command and retrieve the first command response segment.
    The following code example shows how to issue a ICMD call:
    try { props = new DLICallProperty(DLICall.Function.ICMD); props.put(DLICallProperty.Property.COMMAND, "/DISPLAY ACTIVE REGION."); DLICall dliCall = psb.prepareIMSRegionDLICall(props); ICMDCallResult result = (ICMDCallResult) dliCall.execute(); String response = result.getResponseSegment(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I ICMD call, see the topic ICMD call in the IMS Application Programming APIs reference documentation.
  - INIT
```
public static final DLICall.Function INIT
```
    An Initialize (INIT) call allows the application to receive data availability status codes by checking each DB PCB for data availability.
    The following code example shows how to issue a INIT call:
    try { props = new DLICallProperty(DLICall.Function.INIT); props.put(DLICallProperty.Property.AIB_SUB_FUNCTION_CODE, DLICallProperty.Subfunction.DBQUERY); DLICall dliCall = psb.prepareIMSRegionDLICall(props); INITCallResult result = (INITCallResult) dliCall.execute(); Iterator<DBPCB> dbPCBs = result.getDBPCBs().iterator(); while (dbPCBs.hasNext()) { DBPCB dbpcb = dbPCBs.next(); String dbName = dbpcb.getDBName(); short sc = dbpcb.getStatusCode(); } } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I INIT call, see the topic INIT call in the IMS Application Programming APIs reference documentation.
  - INQY
```
public static final DLICall.Function INQY
```
    The Inquiry (INQY) call is used to request information regarding execution environment, destination type and status, and session status. INQY is valid only when using the AIBTDLI interface.
    The following code example shows how to issue a INQY call:
    try { props = new DLICallProperty(DLICall.Function.INQY); props.put(DLICallProperty.Property.AIB_SUB_FUNCTION_CODE, DLICallProperty.Subfunction.FIND); props.put(DLICallProperty.Property.PCB_NAME, "PCB1"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); INQYCallResult result = (INQYCallResult) dliCall.execute(); DBPCB dbPCB = result.getDBPCBs().firstElement(); String pcbName = dbPCB.getDBName(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I INQY call, see the topic INQY call in the IMS Application Programming APIs reference documentation.
  - FLD
```
public static final DLICall.Function FLD
```
    The Field (FLD) call is used to access a field within a segment for MSDBs or DEDBs.
    The following code example shows how to issue a INQY call:
    try { props = new DLICallProperty(DLICall.Function.FLD); props.put(Property.PCB_NAME, "PCB1"); FSA fsa = props.getFSA(); fsa.setFieldName("field1"); fsa.setOpCode(FLD_FSA_OPCODE.ADD); fsa.setOperand("value1"); props.put(Property.FSA, fsa); DLICall call = psb.prepareIMSRegionDLICall(props); FLDCallResult result = (FLDCallResult) call.execute(); FLD_STATUSCODE statusCode = result.getStatusCode(); if (statusCode != FLD_STATUSCODE.b) { // Call failed } } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I FLD call, see the topic FLD call in the IMS Application Programming APIs reference documentation.
  - LOG
```
public static final DLICall.Function LOG
```
    The Log (LOG) call is used to send and write information to the IMS system log.
    The following code example shows how to issue a LOG call:
    try { props = new DLICallProperty(DLICall.Function.LOG); props.put(DLICallProperty.Property.LOG_CODE_BYTE, (byte) 0xA0); props.put(DLICallProperty.Property.LOG_TEXT, "LOGGING FROM JAVA"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); DLICallResult result = dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I LOG call, see the topic LOG call in the IMS Application Programming APIs reference documentation.
  - RCMD
```
public static final DLICall.Function RCMD
```
    A Retrieve Command (RCMD) call enables an automated operator (AO) application program retrieve the second and subsequent command response segments after an ICMD call.
    The following code example shows how to issue a RCMD call:
    try { DLICall dliCall = psb.prepareIMSRegionDLICall(DLICall.Function.RCMD); RCMDCallResult rcmdResult = (RCMDCallResult) dliCall.execute(); String response = rcmdResult.getResponseSegment(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I RCMD call, see the topic RCMD call in the IMS Application Programming APIs reference documentation.
  - RLSE
```
public static final DLICall.Function RLSE
```
    The Release Locks (RLSE) call is used to release all locks held for unmodified data.
    The following code example shows how to issue a RLSE call:
    try { props = new DLICallProperty(DLICall.Function.RLSE); props.put(DLICallProperty.Property.PCB_NAME, "PCB1"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I RLSE call, see the topic RLSE call in the IMS Application Programming APIs reference documentation.
  - ROLL
```
public static final DLICall.Function ROLL
```
    The Roll (ROLL) call backs out output messages sent by a conversational application program and terminates the conversation.
    The following code example shows how to issue a ROLL call:
    try { DLICall dliCall = psb.prepareIMSRegionDLICall(DLICall.Function.ROLL); dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I ROLL call, see the topic ROLL call in the IMS Application Programming APIs reference documentation.
  - ROLS
```
public static final DLICall.Function ROLS
```
    The Roll Back to SETS/SETU (ROLS) call returns message queue positions to sync points established by the SETS/SETU call.
    The following code example shows how to issue a ROLS call:
    try { props = new DLICallProperty(DLICall.Function.ROLS); props.put(DLICallProperty.Property.TOKEN, "1234"); props.put(DLICallProperty.Property.AIB_OUTPUT_AREA_LENGTH, 100); props.put(DLICallProperty.Property.PCB_NAME, "PCB1"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); ROLSCallResult rolsResult = (ROLSCallResult) dliCall.execute(); String savedData = rolsResult.getData(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I ROLS call, see the topic ROLS call in the IMS Application Programming APIs reference documentation.
  - SETS
```
public static final DLICall.Function SETS
```
    The Set Backout Point (SETS) call is used to set an intermediate backout point or to cancel all existing backout points.
    The following code example shows how to issue a SETS call:
    try { props = new DLICallProperty(DLICall.Function.SETS); props.put(DLICallProperty.Property.TOKEN, "1234"); props.put(DLICallProperty.Property.SETDATA, "ZYX"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I SETS call, see the topic SETS call in the IMS Application Programming APIs reference documentation.
  - SETU
```
public static final DLICall.Function SETU
```
    The Set Unconditional (SETU) call operates like the SETS call except that the SETU call isn't rejected if unsupported PCBs are in the PSB or if the program uses an external subsystem.
    The following code example shows how to issue a SETU call:
    try { props = new DLICallProperty(DLICall.Function.SETU); props.put(DLICallProperty.Property.TOKEN, "1234"); props.put(DLICallProperty.Property.SETDATA, "XYZ"); DLICall dliCall = psb.prepareIMSRegionDLICall(props); dliCall.execute(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I SETU call, see the topic SETU call in the IMS Application Programming APIs reference documentation.
  - STAT
```
public static final DLICall.Function STAT
```
    The Statistics (STAT) call is used in a CICS, IMS online, or batch program to obtain database statistics that might be useful for performance monitoring.
    The following code example shows how to issue a STAT call:
    try { props = new DLICallProperty(DLICall.Function.STAT); props.put(DLICallProperty.Property.PCB_NAME, "PCB1"); props.put(DLICallProperty.Property.STAT_TYPE, DLICallProperty.STAT_Option.TYPE_DBAS); props.put(DLICallProperty.Property.STAT_FORMAT, DLICallProperty.STAT_Option.FORMAT_F); props.put(DLICallProperty.Property.CALL_TYPE, DLICallProperty.STAT_Option.STAT_NORMAL); DLICall dliCall = psb.prepareIMSRegionDLICall(props); STATCallResult result = (STATCallResult) dliCall.execute(); String stats = result.getStatistics(); } catch (DLIException e) { e.printStackTrace(); }
    
    For more details about the usage of the DL/I STAT call, see the topic STAT call in the IMS Application Programming APIs reference documentation.
- Method Detail
  - values
```
public static DLICall.Function[] 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 (DLICall.Function c : DLICall.Function.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DLICall.Function 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

Enum DLICall.Function

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTH

DEQ

GMSG

ICMD

INIT

INQY

FLD

LOG

RCMD

RLSE

ROLL

ROLS

SETS

SETU

STAT

Method Detail

values

valueOf