com.ibm.ims.dli

Interface AUTHCallResult

All Superinterfaces:

DLICallResult

public interface AUTHCallResult
extends DLICallResult

Object that represents the output from an Authorization (AUTH) call.

Method Summary

Modifier and Type	Method and Description
short	getExitReturnCode() Retrieves a 2-byte field that contains the return code from the user exits if they were used.
short	getFeedback() Retrieves a 2-byte field that contains the RACF return codes.
short	getStatusCode() Retrieves a 2-byte field that contains the hexadecimal status code indicating installation data status.
java.lang.String	getUserData() Retrieves a String that contains installation data from ACEE or a user security exit.

Methods inherited from interface com.ibm.ims.dli.DLICallResult

getAIB, getDLICallFunction

Method Detail

getFeedback

short getFeedback()

Retrieves a 2-byte field that contains the RACF return codes. This value is stored in the FEEDBACK field in the I/O area.

For more details about the values returned by this method, see the topic AUTH call in the IMS Application Programming APIs reference documentation.

Returns:

the RACF return codes.

getExitReturnCode

short getExitReturnCode()

Retrieves a 2-byte field that contains the return code from the user exits if they were used. This value is stored in the EXITRC field in the I/O area.

For more details about the values returned by this method, see the topic AUTH call in the IMS Application Programming APIs reference documentation.

Returns:

the return code from the user exits.

getStatusCode

short getStatusCode()

Retrieves a 2-byte field that contains the hexadecimal status code indicating installation data status. This value is stored in the STATUS field in the I/O area.

For more details about the values returned by this method, see the topic AUTH call in the IMS Application Programming APIs reference documentation.

Returns:

the status code indicating installation data status.

getUserData

java.lang.String getUserData()
                      throws DLIException

Retrieves a String that contains installation data from ACEE or a user security exit.

For more details about the values returned by this method, see the topic AUTH call in the IMS Application Programming APIs reference documentation.

Returns:

installation data from the RACF Accessor Environment Element (ACEE) or a user security exit. null if no user data returned by IMS.

Throws:

DLIException - if EBCDIC encoding (Cp1047) is not supported