com.ibm.cics.model
Interface IWorkloadRouter

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

public interface IWorkloadRouter
extends ICPSMManager

generated from CICS resourcetable WLMAWTOR


Nested Class Summary
static class IWorkloadRouter.ContactStatusValue
          Enumeration type for field CON_STATUS
static class IWorkloadRouter.OptimizationStatusValue
          Enumeration type for field OWSTATE
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICPSMManager
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IWorkloadRouter> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 IWorkloadRouterReference getCICSObjectReference()
           
 java.lang.String getCmasOwner()
          Getter for field TOROWNER
 IWorkloadRouter.ContactStatusValue getContactStatus()
          Getter for field CON_STATUS
 ICICSType<IWorkloadRouter> getObjectType()
           
 IWorkloadRouter.OptimizationStatusValue getOptimizationStatus()
          Getter for field OWSTATE
 java.lang.String getRoutingRegion()
          Getter for field TOR
 java.lang.String getWorkload()
          Getter for field WORKLOAD
 java.lang.String getWorkloadOwner()
          Getter for field WRKLOWNER
 
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<IWorkloadRouter> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface ICPSMManager
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getWorkload

java.lang.String getWorkload()
Getter for field WORKLOAD

Workload name

The name of the workload specification.


getRoutingRegion

java.lang.String getRoutingRegion()
Getter for field TOR

Routing region name

The name of an active CICS system, acting as a routing region, to which the workload is associated.


getContactStatus

IWorkloadRouter.ContactStatusValue getContactStatus()
Getter for field CON_STATUS

Routing region contact status

The status of the connection between the routing region and the CMAS. Values are:


getWorkloadOwner

java.lang.String getWorkloadOwner()
Getter for field WRKLOWNER

System ID of workload owner

The 4-character CICS system ID of the CMAS that created the workload.


getCmasOwner

java.lang.String getCmasOwner()
Getter for field TOROWNER

Name of controlling CMAS

The name of the controlling CMAS.


getOptimizationStatus

IWorkloadRouter.OptimizationStatusValue getOptimizationStatus()
Getter for field OWSTATE

Optimization status

This field reports the status of the current routing region for the optimized workload routing function.

The possible values are:

ACTIVE
This router region is executing in an optimized workload state.
INACTIVE
This region is capable of executing in an optimized workload state, however, is not currently optimized for one or more of the following reasons:
  • The region has no connection to an RS Server
  • The region is connected to an RS Server, however, the server has not been able to connect to the coupling facility
  • The optimised workload routing function is DISABLED for the current target region
  • The RS server update frequency value for this region is 0, which means that the optimization capabilities for this region are not enabled
N_A
The router region is not configured to provide optimized workload management. Only non optimized WLM routing decisions can be made.

If the CMAS that your WUI is using is not connected to a Region Status (RS) server, the optimization status for remote regions will not be updated and defaults to INACTIVE. Where this situation occurs, either connect all reporting CMASs to the RS server or use the Active target regions view to check the optimization state.


getCICSObjectReference

IWorkloadRouterReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IWorkloadRouter> 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.