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

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

public class JobControlLanguage
extends java.lang.Object
implements java.io.Serializable

This class includes the information required to describe the Job Control Language. It is only used in zOS environment.

The following syntax validation constraints must be met on JobControlLanguage objects in zOS environment:

jobName The jobname of the existing job associated to this JCL
jobWorkstation The name of the existng workstation where the job associated to this JCL runs.
lastUpdatingFunction One of the values exposed by the JCLLastUpdatingFunction class
Default is JCLLastUpdatingFunction.JCL_UPDATE_MODIFYCP
status One of the values exposed by the JCLStatus class
Default is JCLStatus.JCL_COMPLETED
text List of line (string) of jcl. Default is an empty list
expanded Default is false
fromJS Default is false

See Also:
JCLStatus, JCLLastUpdatingFunction, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobControlLanguage()
          Creates an empty object.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this object are equal to those of the given one.
 Identifier getJobId()
          Returns the Job identifier.
 java.lang.String getJobName()
          Returns the Job name.
 java.lang.String getJobWorkstation()
          Returns the Job workstation.
 JCLLastUpdatingFunction getLastUpdatingFunction()
          Returns the last updating function.
 ModifyData getModifyData()
          Returns the Modify Data of this objects
 JCLStatus getStatus()
          Returns the satatus.
 java.util.List getText()
          Returns the List of text lines of the JCL.
 int hashCode()
          Returns a hash code for this object.
 boolean isExpanded()
          Returns true if the JCL is fro JS.
 boolean isFromJS()
          Returns true if the JCL is fro JS.
 void setExpanded(boolean value)
          Sets true if expanded.
 void setFromJs(boolean value)
          Sets true if from JS.
 void setJobId(Identifier value)
          Sets the Job identifier.
 void setJobName(java.lang.String value)
          Sets the Job name.
 void setJobWorkstation(java.lang.String value)
          Sets the Job workstation.
 void setLastUpdatingFunction(JCLLastUpdatingFunction value)
          Sets the last updating function.
 void setModifyData(ModifyData modifyData)
          Sets the modify data
 void setStatus(JCLStatus value)
          Sets the status.
 java.lang.String toString()
          Returns a string representation of this object.
 
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

JobControlLanguage

public JobControlLanguage()
Creates an empty object.

Method Detail

getJobId

public Identifier getJobId()
Returns the Job identifier.

Returns:
The Job identifier.

getJobName

public java.lang.String getJobName()
Returns the Job name.

Returns:
The Job name.

getJobWorkstation

public java.lang.String getJobWorkstation()
Returns the Job workstation.

Returns:
The Job workstation.

getStatus

public JCLStatus getStatus()
Returns the satatus.

Returns:
The status.

getLastUpdatingFunction

public JCLLastUpdatingFunction getLastUpdatingFunction()
Returns the last updating function.

Returns:
The last updating function.

isFromJS

public boolean isFromJS()
Returns true if the JCL is fro JS.

Returns:
True if the JCL is fro JS

isExpanded

public boolean isExpanded()
Returns true if the JCL is fro JS.

Returns:
True if the JCL is fro JS

getText

public java.util.List getText()
Returns the List of text lines of the JCL. The List contains String elements.

Returns:
A List of Strings (the text).

getModifyData

public ModifyData getModifyData()
Returns the Modify Data of this objects

Returns:
Returns the modifyData.

setJobId

public void setJobId(Identifier value)
Sets the Job identifier.

Parameters:
value - The Jonb identifier.

setJobName

public void setJobName(java.lang.String value)
Sets the Job name.

Parameters:
value - The job name.

setJobWorkstation

public void setJobWorkstation(java.lang.String value)
Sets the Job workstation.

Parameters:
value - The job name.

setStatus

public void setStatus(JCLStatus value)
Sets the status.

Parameters:
value - The status.

setLastUpdatingFunction

public void setLastUpdatingFunction(JCLLastUpdatingFunction value)
Sets the last updating function.

Parameters:
value - The status.

setFromJs

public void setFromJs(boolean value)
Sets true if from JS.

Parameters:
value - True if from JS.

setExpanded

public void setExpanded(boolean value)
Sets true if expanded.

Parameters:
value - True if expanded.

setModifyData

public void setModifyData(ModifyData modifyData)
Sets the modify data

Parameters:
modifyData - The modifyData to set.

equals

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

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

hashCode

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all fields.


Copyright © 2005 IBM All Rights Reserved.