com.ibm.ims.dli

Class EnvironInfo

java.lang.Object

com.ibm.ims.dli.EnvironInfo

public class EnvironInfo
extends java.lang.Object

Object that represents the output from an Inquiry (INQY) call that is issued with the ENVIRON subfunction.

For more details about the values returned by the EnvironInfo methods, see the topic INQY call in the IMS Application Programming APIs reference documentation.

Constructor Summary

Constructors

Constructor and Description
EnvironInfo(byte[] ioArea)
EnvironInfo(byte[] ioArea, com.ibm.ims.dli.t2.INQYCallImpl inqyCallImpl) EnvironInfo constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddressSpaceUserid() Retrieves the user ID of the dependent address space.
java.lang.String	getApplicationParameterAddress() Retrieves the address of the LL field, followed by the application program parameter string.
java.lang.String	getApplicationProgramName() Retrieves the application program name.
java.lang.String	getApplicationRegionType() Retrieves the IMS application region type.
java.lang.String	getCatalogIndicator() Indicates whether the catalog is enabled
java.lang.String	getControlRegionType() Retrieves the IMS control region type.
java.lang.String	getGroupName() Retrieves the group name.
java.lang.String	getIdentifier() Retrieves the IMS identifier from the execution parameters.
java.lang.String	getPSBName() Retrieves the PSB name.
int	getReasonCode() Gets the reason code produced by the ENVIRON INQY DLI call.
java.lang.String	getReasonCodeHex() Gets the reason code produced by the ENVIRON INQY DLI call as a hexadecimal string.
java.lang.String	getRecoveryTokenAddress() Retrieves the address of the LL field, followed by the recovery token.
java.lang.String	getRegionIdentifier() Retrieves the region identifier as a hex string.
int	getRegionIdentifierAsInt() Retrieves the region identifier as an integer.
java.lang.String	getReleaseLevel() Retrieves the release level for IMS.
int	getReturnCode() Gets the return code produced by the ENVIRON INQY DLI call.
java.lang.String	getReturnCodeHex() Gets the return code produced by the ENVIRON INQY DLI call as a hexadecimal string.
java.lang.String	getRRSIndicator() Indicates whether IMS has interest in the UR with RRS
java.lang.String	getSharedQueueIndicator() Retrieves the shared queue indicator.
int	getStatusCode() Gets the IMS status code of the INQY call from the IOPCB.
java.lang.String	getStatusCodeChars() Gets the IMS status code of the INQY call from the IOPCB as a character string.
java.lang.String	getStatusGroupIndicator() Retrieves the status group indicator.
java.lang.String	getTransactionName() Retrieves the transaction name.
java.lang.String	getUserIdentifier() Retrieves the user identifier.
java.lang.String	getUseridIndicator() Retrieves the contents of the user ID field.
java.lang.String	getUserIDIndicator() Retrieves the user identifier.
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironInfo

public EnvironInfo(byte[] ioArea,
                   com.ibm.ims.dli.t2.INQYCallImpl inqyCallImpl)
            throws java.io.UnsupportedEncodingException

EnvironInfo constructor.

Parameters:

ioArea - a byte array that represents the data output area.

Throws:

java.io.UnsupportedEncodingException

EnvironInfo

public EnvironInfo(byte[] ioArea)
            throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

Method Detail

getReasonCode

public int getReasonCode()

Gets the reason code produced by the ENVIRON INQY DLI call.

Returns:

the reason code of the INQY DLI call

getReasonCodeHex

public java.lang.String getReasonCodeHex()

Gets the reason code produced by the ENVIRON INQY DLI call as a hexadecimal string.

Returns:

the reason code of the INQY DLI call

getReturnCode

public int getReturnCode()

Gets the return code produced by the ENVIRON INQY DLI call.

Returns:

the return code of the INQY DLI call

getReturnCodeHex

public java.lang.String getReturnCodeHex()

Gets the return code produced by the ENVIRON INQY DLI call as a hexadecimal string.

Returns:

the return code of the INQY DLI call

getStatusCode

public int getStatusCode()

Gets the IMS status code of the INQY call from the IOPCB.

Returns:

the IMS status code of the INQY DLI call.

getStatusCodeChars

public java.lang.String getStatusCodeChars()

Gets the IMS status code of the INQY call from the IOPCB as a character string.

Returns:

the IMS status code of the INQY DLI call.

getIdentifier

public java.lang.String getIdentifier()

Retrieves the IMS identifier from the execution parameters.

Returns:

the IMS identifier.

getReleaseLevel

public java.lang.String getReleaseLevel()

Retrieves the release level for IMS. For example, if IMS Version is 11 and Release is 1, then the value would be 1110.

Returns:

the release level for IMS.

getControlRegionType

public java.lang.String getControlRegionType()

Retrieves the IMS control region type.

Returns:

the IMS control region type.

getApplicationRegionType

public java.lang.String getApplicationRegionType()

Retrieves the IMS application region type.

Returns:

the IMS application region type.

getRegionIdentifier

public java.lang.String getRegionIdentifier()

Retrieves the region identifier as a hex string.

Returns:

the region identifier.

getRegionIdentifierAsInt

public int getRegionIdentifierAsInt()

Retrieves the region identifier as an integer.

Returns:

the region identifier.

getApplicationProgramName

public java.lang.String getApplicationProgramName()

Retrieves the application program name.

Returns:

the name of the application program being run.

getPSBName

public java.lang.String getPSBName()

Retrieves the PSB name.

Returns:

the name of the PSB currently allocated.

getTransactionName

public java.lang.String getTransactionName()

Retrieves the transaction name. An empty string indicates that no associated transaction exists.

Returns:

the name of the transaction.

getUserIdentifier

public java.lang.String getUserIdentifier()

Retrieves the user identifier. An empty string indicates that the user ID is unavailable.

Returns:

the user ID.

getUserIDIndicator

public java.lang.String getUserIDIndicator()

Retrieves the user identifier. An empty string indicates that the user ID is unavailable.

Returns:

the user ID.

getGroupName

public java.lang.String getGroupName()

Retrieves the group name. An empty string indicates that the group name is unavailable.

Returns:

the group name.

getStatusGroupIndicator

public java.lang.String getStatusGroupIndicator()

Retrieves the status group indicator.

Returns:

the status group indicator

getRecoveryTokenAddress

public java.lang.String getRecoveryTokenAddress()

Retrieves the address of the LL field, followed by the recovery token.

Returns:

the address of recovery token.

getApplicationParameterAddress

public java.lang.String getApplicationParameterAddress()

Retrieves the address of the LL field, followed by the application program parameter string.

Returns:

the address of the application.

getSharedQueueIndicator

public java.lang.String getSharedQueueIndicator()

Retrieves the shared queue indicator.

Returns:

the shared queue indicator

getAddressSpaceUserid

public java.lang.String getAddressSpaceUserid()

Retrieves the user ID of the dependent address space.

Returns:

user ID of the dependent address space.

getUseridIndicator

public java.lang.String getUseridIndicator()

Retrieves the contents of the user ID field.

Returns:

the user ID indicator field.

getRRSIndicator

public java.lang.String getRRSIndicator()

Indicates whether IMS has interest in the UR with RRS

Returns:

RRS indicates IMS has expressed interest in the UR with RRS. Blank indicates that IMS has not expressed interest in the UR with RRS

getCatalogIndicator

public java.lang.String getCatalogIndicator()

Indicates whether the catalog is enabled

Returns:

CATALOG if enabled. Blank if not enabled.

main

public static void main(java.lang.String[] args)