com.ibm.cics.model
Interface IUnitOfWorkEnqueue

All Superinterfaces:
ICICSObject, ICICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IUnitOfWorkEnqueue
extends ICICSResource

generated from CICS resourcetable UOWENQ


Nested Class Summary
static class IUnitOfWorkEnqueue.EnqueueTypeValue
          Enumeration type for field STATE
static class IUnitOfWorkEnqueue.RelationValue
          Enumeration type for field RELATION
static class IUnitOfWorkEnqueue.ResourceTypeValue
          Enumeration type for field TYPE
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IUnitOfWorkEnqueue> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 IUnitOfWorkEnqueueReference getCICSObjectReference()
           
 java.lang.String getEnqaddress()
          Getter for field ENQADDRESS
 java.lang.Long getEnqfails()
          Getter for field ENQFAILS
 java.lang.String getEnqscope()
          Getter for field ENQSCOPE
 IUnitOfWorkEnqueue.EnqueueTypeValue getEnqueueType()
          Getter for field STATE
 java.lang.String getNetuowid()
          Getter for field NETUOWID
 ICICSType<IUnitOfWorkEnqueue> getObjectType()
           
 java.lang.String getQualifier()
          Getter for field QUALIFIER
 java.lang.Long getQuallen()
          Getter for field QUALLEN
 IUnitOfWorkEnqueue.RelationValue getRelation()
          Getter for field RELATION
 java.lang.Long getReslen()
          Getter for field RESLEN
 java.lang.String getResource()
          Getter for field RESOURCE
 IUnitOfWorkEnqueue.ResourceTypeValue getResourceType()
          Getter for field TYPE
 java.lang.String getTaskID()
          Getter for field TASKID
 java.lang.String getTransactionID()
          Getter for field TRANSID
 java.lang.String getUnitOfWorkID()
          Getter for field UOWID
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<IUnitOfWorkEnqueue> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getUnitOfWorkID

java.lang.String getUnitOfWorkID()
Getter for field UOWID

Unit of work (UOW) ID

The local ID of the unit of work that owns or is waiting for the enqueue.


getTransactionID

java.lang.String getTransactionID()
Getter for field TRANSID

Transaction ID associated with UOW

The transaction identifier associated with the unit of work. If the unit of work is shunted, this is the transaction ID associated with the unit of work before it was shunted.


getTaskID

java.lang.String getTaskID()
Getter for field TASKID

Task number associated with UOW

The task number of the task associated with the unit of work. If the unit of work is shunted, this is the task number associated with the unit of work before it was shunted.


getEnqueueType

IUnitOfWorkEnqueue.EnqueueTypeValue getEnqueueType()
Getter for field STATE

Enqueue type

Indicates the state that the enqueue is held in (ACTIVE, RETAINED).


getResourceType

IUnitOfWorkEnqueue.ResourceTypeValue getResourceType()
Getter for field TYPE

Resource type

Identifies the type of resource for which enqueue data is provided (DATASET, EXECENQ, EXECENQADDR, FILE, TDQUEUE, TSQUEUE)


getRelation

IUnitOfWorkEnqueue.RelationValue getRelation()
Getter for field RELATION

Owner or task waiting

Indicates whether the data is associated with the owner of the enqueue (OWNER) or a task waiting for the enqueue (WAITER).


getEnqfails

java.lang.Long getEnqfails()
Getter for field ENQFAILS

Number of enqueue failures since last acquire

The number of failed enqueue attempts for this resource since the enqueue was last acquired. In other words, the number of units of work that have received a LOCKED response due to this enqueue being held in retained state. For active enqueues, the value is zero.


getQuallen

java.lang.Long getQuallen()
Getter for field QUALLEN

Length of resource qualifier (bytes)

The length of the qualifier of the resource associated with the enqueue.


getReslen

java.lang.Long getReslen()
Getter for field RESLEN

Length of resource name (bytes)

The length of the name of the resource associated with the enqueue.


getResource

java.lang.String getResource()
Getter for field RESOURCE

Resource name

The 1-255 character name of the resource associated with the enqueue lock. The data returned in this field depends on the TYPE of the enqueue.


getQualifier

java.lang.String getQualifier()
Getter for field QUALIFIER

Resource name qualifier

The optional 1-255 character qualifier that further identifies the resource associated with the enqueue.


getNetuowid

java.lang.String getNetuowid()
Getter for field NETUOWID

Network-wide LU6.2 unit of work (UOW) id

The LU6.2 name for the unit of work that owns or is waiting for the enqueue.


getEnqscope

java.lang.String getEnqscope()
Getter for field ENQSCOPE

ENQ scope name

This identifies the optional four character enqueue scope name.


getEnqaddress

java.lang.String getEnqaddress()
Getter for field ENQADDRESS

Address of EXEC enqueue argument

The address of the enqueue argument passed on an EXEC CICS ENQ request for resources of type EXECENQADDR. For all other resource types, the value is zero.


getCICSObjectReference

IUnitOfWorkEnqueueReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IUnitOfWorkEnqueue> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



Copyright © 2008-2013 IBM Corp. All Rights Reserved.