com.ibm.tws.objects.plan.types
Class WorkstationInPlanZOSAttributes

java.lang.Object
  extended bycom.ibm.tws.objects.types.WorkstationZOSAttributes
      extended bycom.ibm.tws.objects.plan.types.WorkstationInPlanZOSAttributes
All Implemented Interfaces:
java.io.Serializable

public class WorkstationInPlanZOSAttributes
extends WorkstationZOSAttributes

This object is a container for the zOS specific attributes for a Workstation in plan object; these attributes are only valid when the workstation is a z/OS workstation.

The following syntax validation constraints must be met on WorkstationInPlanZOSAttributes.java objects in ZOS environment:

completedJobSummary Output only
startedJobSummary Output only
waitingJobSummary Output only
interruptedJobSummary Output only
readyJobSummary Output only
reportingAttiribute One of the values defined in WorkstationReportingAttribute class
server1NumberInUse Default is 0
server2NumberInUse Default is 0
status One of the values defined in WorkstationStatus class
Default is WorkstationStatus.WORKSTATION_STATUS_OFFLINE
extendedStatus One of the values defined in WorkstationInPlanExtendedStatus class
Default is WorkstationInPlanExtendedStatus.NONE
controlOnServer //Default is false
rerouteModel //Default is false
server1UsedForControl //Default is false
server2UsedForControl //Default is false
isWait Default value is false

See Also:
WorkstationStatus, WorkstationInPlanExtendedStatus, WorkstationReportingAttribute, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
WorkstationInPlanZOSAttributes()
          Creates an empty WorkstationInPlanZOSAttributes object
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this WorkstationInPlanZOSAttributes object are equal to those of the given one.
 JobSummaryInfo getCompletedJobSummary()
          This method returns the summary information for all the jobs that was completed on this workstation
 WorkstationInPlanExtendedStatus getExtendedStatus()
          This method returns the extended status of a z/OS Workstation in plan
 JobSummaryInfo getInterruptedJobSummary()
          This method returns the summary information for all the jobs that was interrupted on this workstation
 JobSummaryInfo getReadyJobSummary()
          This method returns the summary information for all the jobs that was ready on this workstation
 WorkstationReportingAttribute getReportingAttribute()
          Returns the workstation reporting attribute.
 int getServer1NumberInUse()
          This method returns the number of workstation resource2 used
 int getServer2NumberInUse()
          This method returns the number of workstation resource1 used
 JobSummaryInfo getStartedJobSummary()
          This method returns the summary information for all the jobs that was started on this workstation
 WorkstationStatus getStatus()
          This method returns the status of a z/OS Workstation in plan
 JobSummaryInfo getWaitingJobSummary()
          This method returns the summary information for all the jobs that was waiting on this workstation
 int hashCode()
          Returns a hash code for this WorkstationInPlanZOSAttributes object.
 boolean isControlOnServers()
          This method returns the information if parallel servers are considere when submitting or releasing a job
 boolean isRerouteMode()
          This method returns the reroute mode of a z/OS Workstation in plan
 boolean isServer1UsedforControl()
          This method returns the information if workstation resource1 is used for controlling jobs on this workstation
 boolean isServer2UsedforControl()
          This method returns the information if workstation resource2 is used for controlling jobs on this workstation
 boolean isWait()
          Returns true if the option wait on this workstation is checked.
 void setCompletedJobSummary(JobSummaryInfo completedJobSummary)
          Sets the Job summary info for completed jobs
 void setControlOnServers(boolean controlOnServers)
          Sets the information if paralle server is used to control jobs on the workstation
 void setExtendedStatus(WorkstationInPlanExtendedStatus extStatus)
          Set the extended status of the workstation.
 void setInterruptedJobSummary(JobSummaryInfo interruptedJobSummary)
          Sets the Job summary info for interrupted jobs
 void setReadyJobSummary(JobSummaryInfo readyJobSummary)
          Sets the Job summary info for ready jobs
 void setReportingAttribute(WorkstationReportingAttribute value)
          Sets the workstation reporting attribute.
 void setRerouteMode(boolean rerouteMode)
          Sets the reroute mode flag
 void setServer1NumberInUse(int server1NumberInUse)
          Sets the quantity in sue for R1 This method is for internal use only.
 void setServer1UsedforControl(boolean server1UsedforControl)
          Sets the information if workstation associated resourceR1 is used or not to control jobs
 void setServer2NumberInUse(int server2NumberInUse)
          Sets the quantity in sue for R2 This method is for internal use only.
 void setServer2UsedforControl(boolean server2UsedforControl)
          Sets the information if workstation associated resourceR2 is used or not to control jobs
 void setStartedJobSummary(JobSummaryInfo startedJobSummary)
          Sets the Job summary info for started jobs
 void setStatus(WorkstationStatus status)
          Set the status of the workstation.
 void setWait(boolean value)
          Sets the option wait on this workstation.
 void setWaitingJobSummary(JobSummaryInfo waitingJobSummary)
          Sets the Job summary info for waiting jobs
 java.lang.String toString()
          Returns a string representation of this WorkstationInPlanZOSAttributes object.
 
Methods inherited from class com.ibm.tws.objects.types.WorkstationZOSAttributes
getAccessMethodNodeAddress, getAccessMethodPort, getDefaultJobDuration, getDefaultTransportTime, getDestination, getParallelServersUsage, getPrintoutRouting, getServer1Name, getServer1Usage, getServer2Name, getServer2Usage, getSupportedTaskTypes, getSuReDatasetName, isJobSetupAllowed, isSplittable, isStartedTaskSupported, isWTOSupported, setAccessMethodNodeAddress, setAccessMethodPort, setDefaultJobDuration, setDefaultTransportTime, setDestination, setJobSetupAllowed, setParallelServersUsage, setPrintoutRouting, setServer1Name, setServer1Usage, setServer2Name, setServer2Usage, setSplittable, setStartedTaskSupported, setSuReDatasetName, setWTOSupported
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

WorkstationInPlanZOSAttributes

public WorkstationInPlanZOSAttributes()
Creates an empty WorkstationInPlanZOSAttributes object

Method Detail

getStatus

public WorkstationStatus getStatus()
This method returns the status of a z/OS Workstation in plan

Returns:
The Status of the workstation.

getExtendedStatus

public WorkstationInPlanExtendedStatus getExtendedStatus()
This method returns the extended status of a z/OS Workstation in plan

Returns:
The extended Status of the workstation.

isRerouteMode

public boolean isRerouteMode()
This method returns the reroute mode of a z/OS Workstation in plan

Returns:
Returns the rerouteMode.

isControlOnServers

public boolean isControlOnServers()
This method returns the information if parallel servers are considere when submitting or releasing a job

Returns:
Returns true if parallel servers should be considered

isServer1UsedforControl

public boolean isServer1UsedforControl()
This method returns the information if workstation resource1 is used for controlling jobs on this workstation

Returns:
Returns True, if jobs on this workstation are submitted or released only if the requested resource amount is available.

isServer2UsedforControl

public boolean isServer2UsedforControl()
This method returns the information if workstation resource2 is used for controlling jobs on this workstation

Returns:
Returns True, if jobs on this workstation are submitted or released only if the requested resource amount is available.

getServer2NumberInUse

public int getServer2NumberInUse()
This method returns the number of workstation resource1 used

Returns:
Returns the server1NumberInUse.

getServer1NumberInUse

public int getServer1NumberInUse()
This method returns the number of workstation resource2 used

Returns:
Returns the server2NumberInUse.

getReportingAttribute

public WorkstationReportingAttribute getReportingAttribute()
Returns the workstation reporting attribute. This is valid only for a z/OS workstation.

Returns:
The workstation reporting attribute.

getCompletedJobSummary

public JobSummaryInfo getCompletedJobSummary()
This method returns the summary information for all the jobs that was completed on this workstation

Returns:
Returns the JobSummary for completed jobs.

getInterruptedJobSummary

public JobSummaryInfo getInterruptedJobSummary()
This method returns the summary information for all the jobs that was interrupted on this workstation

Returns:
Returns the JobSummary for interrupted jobs.

getStartedJobSummary

public JobSummaryInfo getStartedJobSummary()
This method returns the summary information for all the jobs that was started on this workstation

Returns:
Returns the JobSummary for started jobs.

getWaitingJobSummary

public JobSummaryInfo getWaitingJobSummary()
This method returns the summary information for all the jobs that was waiting on this workstation

Returns:
Returns the JobSummary for waiting jobs.

getReadyJobSummary

public JobSummaryInfo getReadyJobSummary()
This method returns the summary information for all the jobs that was ready on this workstation

Returns:
Returns the JobSummary for ready jobs.

isWait

public boolean isWait()
Returns true if the option wait on this workstation is checked.

Overrides:
isWait in class WorkstationZOSAttributes
Returns:
Returns true if the option wait on this workstation is checked.

setStatus

public void setStatus(WorkstationStatus status)
Set the status of the workstation.

Parameters:
status - The WorkstationStatus to be set.

setExtendedStatus

public void setExtendedStatus(WorkstationInPlanExtendedStatus extStatus)
Set the extended status of the workstation.

Parameters:
extStatus - The WorkstationInPlanExtendedStatus to be set.

setRerouteMode

public void setRerouteMode(boolean rerouteMode)
Sets the reroute mode flag

Parameters:
rerouteMode - The rerouteMode to set.

setControlOnServers

public void setControlOnServers(boolean controlOnServers)
Sets the information if paralle server is used to control jobs on the workstation

Parameters:
controlOnServers - The controlOnServers to set.

setServer1UsedforControl

public void setServer1UsedforControl(boolean server1UsedforControl)
Sets the information if workstation associated resourceR1 is used or not to control jobs

Parameters:
server1UsedforControl - The server1UsedforControl to set.

setServer2UsedforControl

public void setServer2UsedforControl(boolean server2UsedforControl)
Sets the information if workstation associated resourceR2 is used or not to control jobs

Parameters:
server2UsedforControl - The server2UsedforControl to set.

setServer1NumberInUse

public void setServer1NumberInUse(int server1NumberInUse)
Sets the quantity in sue for R1 This method is for internal use only.

Parameters:
server1NumberInUse - The server1NumberInUse to set.

setServer2NumberInUse

public void setServer2NumberInUse(int server2NumberInUse)
Sets the quantity in sue for R2 This method is for internal use only.

Parameters:
server2NumberInUse - The server2NumberInUse to set.

setReportingAttribute

public void setReportingAttribute(WorkstationReportingAttribute value)
Sets the workstation reporting attribute. This is valid only for a z/OS workstation.

Parameters:
value - The workstation reporting attribute.

setCompletedJobSummary

public void setCompletedJobSummary(JobSummaryInfo completedJobSummary)
Sets the Job summary info for completed jobs

Parameters:
completedJobSummary - The completedJobSummary to set.

setInterruptedJobSummary

public void setInterruptedJobSummary(JobSummaryInfo interruptedJobSummary)
Sets the Job summary info for interrupted jobs

Parameters:
interruptedJobSummary - The interruptedJobSummary to set.

setStartedJobSummary

public void setStartedJobSummary(JobSummaryInfo startedJobSummary)
Sets the Job summary info for started jobs

Parameters:
startedJobSummary - The startedJobSummary to set.

setWaitingJobSummary

public void setWaitingJobSummary(JobSummaryInfo waitingJobSummary)
Sets the Job summary info for waiting jobs

Parameters:
waitingJobSummary - The waitingJobSummary to set.

setReadyJobSummary

public void setReadyJobSummary(JobSummaryInfo readyJobSummary)
Sets the Job summary info for ready jobs

Parameters:
readyJobSummary - The readyJobSummary to set.

setWait

public void setWait(boolean value)
Sets the option wait on this workstation.

Overrides:
setWait in class WorkstationZOSAttributes
Parameters:
value - The option wait on this workstation.
Returns:
Sets the option wait on this workstation.

toString

public java.lang.String toString()
Returns a string representation of this WorkstationInPlanZOSAttributes object.

Overrides:
toString in class WorkstationZOSAttributes
Returns:
A text string including all WorkstationInPlanZOSAttributes fields.

hashCode

public int hashCode()
Returns a hash code for this WorkstationInPlanZOSAttributes object.

Overrides:
hashCode in class WorkstationZOSAttributes
Returns:
The object's hash code.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this WorkstationInPlanZOSAttributes object are equal to those of the given one.

Overrides:
equals in class WorkstationZOSAttributes
Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.


Copyright © 2005 IBM All Rights Reserved.