com.ibm.tws.objects.model
Class ZOSJobDefinition

java.lang.Object
  extended bycom.ibm.tws.objects.model.JobDefinition
      extended bycom.ibm.tws.objects.model.ZOSJobDefinition
All Implemented Interfaces:
java.io.Serializable, TWSObject

public class ZOSJobDefinition
extends JobDefinition

This object represents a TWS for z/OS job definition.

The following syntax validation constraints must be met on ZOSJobDefinition objects in z/OS environment:

jclName Always required
Alphanumeric and national characters
Starting with alphabetic or national character
Blank spaces not allowed
Not longer than 8 characters
jobClass Valid values are uppercase characters from 'A' to 'Z'
Default value is ' ' (not set)
printClass Valid values are uppercase characters from 'A' to 'Z'
Default value is ' ' (not set)
formNumber Not longer than 8 characters
reportingAttribute One of the values exposed by the WorkstationReportingAttribute class
Default value is WorkstationReportingAttribute.NONREPORTING
catManagementOption One of the values exposed by the CatManagementOption class
Default value is CatManagementOption.NONE
cleanUpOption One of the values exposed by the CleanUpOption class
Default value is CleanUpOption.NONE
expandedJCL Default value is false
userSysOut Default value is false
wlmCriticalJob Default value is false
wlmCriticalJobType One of the values exposed by the CriticalJobType class
Default value is CriticalJobType.NO
wlmPolicy One of the values exposed by the WLMPolicy class
Default value is WLMPolicy.DEADLINE
wlmClass Not longer than 8 characters
smoothingFactor Valid range is from 0 to 999
Default value is 0
limitForFeedback Valid range is from 100 to 999
Default value is 100
highestOkReturnCode Valid range is from 0 to 4095
Default value is 0
autoSubmit Default value is false
autoRelease Default value is false
cancelIfLate Default value is false
autoErrorCompletion Default value is false
deadlineWTO Default value is false
restartableOption One of the values exposed by the YesNoDefaultOption class
Default value is YesNoDefaultOption.DEFAULT
reroutableOption One of the values exposed by the YesNoDefaultOption class
Default value is YesNoDefaultOption.DEFAULT
owningOpNumber Valid range is from 0 to 255
Default value is 0
hasCentralizedScript Default value is false
useExtendedTaskName Default value is false
extendedName Not longer than 54 characters
useSchedulingEnvironment Default value is false
schedulingEnvironmentName Not longer than 16 characters
commandText Not longer than 256 characters
automatedFunction Not longer than 8 characters
securityElement Not longer than 8 characters
completionInfo Not longer than 64 characters

See Also:
JobDefinition, WorkstationReportingAttribute, CatManagementOption, CleanUpOption, CriticalJobType, WLMPolicy, YesNoDefaultOption, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ZOSJobDefinition()
          Creates an empty ZOSJobDefinition.
ZOSJobDefinition(JobDefinitionHeader jobDefinitionHeader)
          Creates a ZOSJobDefinition with the specified header.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this ZOSJobDefinition object are equal to those of the given one.
 boolean getAutoErrorCompletion()
          Returns the auto error completion option.
 java.lang.String getAutomatedFunction()
          Returns the automated function (system automation).
 boolean getAutoRelease()
          Returns the auto release option.
 boolean getAutoSubmit()
          Returns the auto submit option.
 boolean getCancelIfLate()
          Returns the cancel if late option.
 CatManagementOption getCatManagementOption()
          Returns the catalog management option
 CleanUpOption getCleanUpOption()
          Returns the cleanup option.
 java.lang.String getCommandText()
          Returns the command text (system automation).
 java.lang.String getCompletionInfo()
          Returns the completion info (system automation).
 boolean getDeadlineWTO()
          Returns the deadline WTO option.
 boolean getExpandedJCL()
          Returns the expanded JCL property.
 java.lang.String getExtendedName()
          Returns the extended name.
 java.lang.String getFormNumber()
          Returns the form number.
 boolean getHasCentralizedScript()
          Returns the has centralized script option.
 int getHighestOkReturnCode()
          Returns the highest OK return code.
 java.lang.String getJclName()
          Returns the JCL name.
 char getJobClass()
          Returns the job class.
 int getLimitForFeedback()
          Returns the limit for feedback.
 long getOwningOpNumber()
          Returns the owning operation number.
 char getPrintClass()
          Returns the print class
 WorkstationReportingAttribute getReportingAttribute()
          Returns the reporting attribute.
 YesNoDefaultOption getReroutableOption()
          Returns the reroutable option.
 YesNoDefaultOption getRestartableOption()
          Returns the restartable option.
 java.lang.String getSchedulingEnvironmentName()
          Returns the scheduling environment name.
 java.lang.String getSecurityElement()
          Returns the security element (system automation).
 int getSmoothingFactor()
          Returns the smoothing factor.
 boolean getUserSysOut()
          Returns the user sysout option.
 java.lang.String getWLMClass()
          Returns the WLM class.
 boolean getWLMCriticalJob()
          Returns the WLM critical job property.
 CriticalJobType getWLMCriticalJobType()
          Returns the CriticalJobType option.
 WLMPolicy getWLMPolicy()
          Returns the WLM policy.
 int hashCode()
          Returns a hash code for this ZOSJobDefinition object.
 boolean isUseExtendedTaskName()
          Returns the use extended task name option.
 boolean isUseSchedulingEnvironment()
          Returns the use scheduling environment name option.
 void setAutoErrorCompletion(boolean value)
          Returns the auto error completion option.
 void setAutomatedFunction(java.lang.String value)
          Sets the automated function (system automation).
 void setAutoRelease(boolean value)
          Returns the auto release option.
 void setAutoSubmit(boolean value)
          Returns the auto submit option.
 void setCancelIfLate(boolean value)
          Returns the cancel if late option.
 void setCatManagementOption(CatManagementOption value)
          Returns the catalog management option.
 void setCleanUpOption(CleanUpOption value)
          Returns the cleanup option.
 void setCommandText(java.lang.String value)
          Sets the command text (system automation).
 void setCompletionInfo(java.lang.String value)
          Sets the completion info (system automation).
 void setDeadlineWTO(boolean value)
          Returns the deadline WTO option.
 void setExpandedJCL(boolean value)
          Returns the expanded JCL property.
 void setExtendedName(java.lang.String value)
          Sets the extended name.
 void setFormNumber(java.lang.String value)
          Sets the form number.
 void setHasCentralizedScript(boolean value)
          Returns the has centralized script option.
 void setHighestOkReturnCode(int value)
          Returns the highest OK return code.
 void setJclName(java.lang.String value)
          Sets the JCL name.
 void setJobClass(char value)
          Sets the job class.
 void setLimitForFeedback(int value)
          Returns the limit for feedback.
 void setOwningOpNumber(int value)
          Sets the owning operation number.
 void setPrintClass(char value)
          Sets the print class.
 void setReportingAttribute(WorkstationReportingAttribute value)
          Sets the reporting attribute.
 void setReroutableOption(YesNoDefaultOption value)
          Returns the reroutable option.
 void setRestartableOption(YesNoDefaultOption value)
          Returns the restartable option.
 void setSchedulingEnvironmentName(java.lang.String value)
          Sets the scheduling environment name.
 void setSecurityElement(java.lang.String value)
          Sets the security element (system automation).
 void setSmoothingFactor(int value)
          Returns the smoothing factor.
 void setUseExtendedTaskName(boolean value)
          Sets the use extended task name option.
 void setUserSysOut(boolean value)
          Returns the user sysout option.
 void setUseSchedulingEnvironment(boolean value)
          Sets the use scheduling environment name option.
 void setWLMClass(java.lang.String value)
          Sets the WLM class.
 void setWLMCriticalJob(boolean value)
          Returns the WLM critical job property.
 void setWLMCriticalJobType(CriticalJobType value)
          Sets the CriticalJobType option.
 void setWLMPolicy(WLMPolicy value)
          Returns the WLM policy.
 java.lang.String toString()
          Returns a string representation of this ZOSJobDefinition object.
 
Methods inherited from class com.ibm.tws.objects.model.JobDefinition
getDescription, getFlowTargetId, getFlowTargetKey, getHeader, getId, getKey, getLockData, getModifyData, getName, getNormalElapsedTime, getObjectHeader, getObjectKey, getTaskType, getUserLogin, isCommand, setCommand, setDescription, setFlowTargetId, setFlowTargetKey, setHeader, setId, setKey, setLockData, setModifyData, setName, setNormalElapsedTime, setTaskType, setUserLogin
 
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

ZOSJobDefinition

public ZOSJobDefinition()
Creates an empty ZOSJobDefinition.


ZOSJobDefinition

public ZOSJobDefinition(JobDefinitionHeader jobDefinitionHeader)
Creates a ZOSJobDefinition with the specified header.

Parameters:
jobDefinitionHeader - The job definition header.
Method Detail

getJclName

public java.lang.String getJclName()
Returns the JCL name.

Returns:
The JCL name.

getJobClass

public char getJobClass()
Returns the job class.

Returns:
The job class.

getPrintClass

public char getPrintClass()
Returns the print class

Returns:
The print class.

getFormNumber

public java.lang.String getFormNumber()
Returns the form number.

Returns:
The form number.

getReportingAttribute

public WorkstationReportingAttribute getReportingAttribute()
Returns the reporting attribute.

Returns:
The reporting attribute.

getCatManagementOption

public CatManagementOption getCatManagementOption()
Returns the catalog management option

Returns:
The catalog management option.

getCleanUpOption

public CleanUpOption getCleanUpOption()
Returns the cleanup option.

Returns:
The cleanup option.

getExpandedJCL

public boolean getExpandedJCL()
Returns the expanded JCL property.

Returns:
The expanded JCL property.

getUserSysOut

public boolean getUserSysOut()
Returns the user sysout option.

Returns:
The user sysout option.

getWLMCriticalJob

public boolean getWLMCriticalJob()
Returns the WLM critical job property.

Returns:
The WLM critical job property.

getWLMCriticalJobType

public CriticalJobType getWLMCriticalJobType()
Returns the CriticalJobType option.

Returns:
The CriticalJobType option.

getWLMPolicy

public WLMPolicy getWLMPolicy()
Returns the WLM policy.

Returns:
The WLM policy.

getWLMClass

public java.lang.String getWLMClass()
Returns the WLM class.

Returns:
The WLM class.

getSmoothingFactor

public int getSmoothingFactor()
Returns the smoothing factor.

Returns:
The smoothing factor.

getLimitForFeedback

public int getLimitForFeedback()
Returns the limit for feedback.

Returns:
The limit for feedback.

getHighestOkReturnCode

public int getHighestOkReturnCode()
Returns the highest OK return code.

Returns:
The highest OK return code.

getAutoSubmit

public boolean getAutoSubmit()
Returns the auto submit option.

Returns:
The auto submit option.

getAutoRelease

public boolean getAutoRelease()
Returns the auto release option.

Returns:
The auto release option.

getCancelIfLate

public boolean getCancelIfLate()
Returns the cancel if late option.

Returns:
The cancel if late option.

getAutoErrorCompletion

public boolean getAutoErrorCompletion()
Returns the auto error completion option.

Returns:
The auto error completion option.

getDeadlineWTO

public boolean getDeadlineWTO()
Returns the deadline WTO option.

Returns:
The deadline WTO option.

getRestartableOption

public YesNoDefaultOption getRestartableOption()
Returns the restartable option.

Returns:
The restartable option.

getReroutableOption

public YesNoDefaultOption getReroutableOption()
Returns the reroutable option.

Returns:
The reroutable option.

getOwningOpNumber

public long getOwningOpNumber()
Returns the owning operation number.

Returns:
The owning operation number.

getHasCentralizedScript

public boolean getHasCentralizedScript()
Returns the has centralized script option.

Returns:
The has centralized script option.

isUseExtendedTaskName

public boolean isUseExtendedTaskName()
Returns the use extended task name option.

Returns:
The use extended task name option.

getExtendedName

public java.lang.String getExtendedName()
Returns the extended name.

Returns:
The extended name.

isUseSchedulingEnvironment

public boolean isUseSchedulingEnvironment()
Returns the use scheduling environment name option.

Returns:
The use scheduling environment name option.

getSchedulingEnvironmentName

public java.lang.String getSchedulingEnvironmentName()
Returns the scheduling environment name.

Returns:
The scheduling environment name.

getCommandText

public java.lang.String getCommandText()
Returns the command text (system automation).

Returns:
The command text (system automation).

getAutomatedFunction

public java.lang.String getAutomatedFunction()
Returns the automated function (system automation).

Returns:
The automated function (system automation).

getSecurityElement

public java.lang.String getSecurityElement()
Returns the security element (system automation).

Returns:
The security element (system automation).

getCompletionInfo

public java.lang.String getCompletionInfo()
Returns the completion info (system automation).

Returns:
The completion info (system automation).

setJclName

public void setJclName(java.lang.String value)
Sets the JCL name.

Parameters:
value - The JCL name.

setJobClass

public void setJobClass(char value)
Sets the job class.

Parameters:
value - The job class.

setPrintClass

public void setPrintClass(char value)
Sets the print class.

Parameters:
value - The print class.

setFormNumber

public void setFormNumber(java.lang.String value)
Sets the form number.

Parameters:
value - The form number.

setReportingAttribute

public void setReportingAttribute(WorkstationReportingAttribute value)
Sets the reporting attribute.

Parameters:
value - The reporting attribute.

setCatManagementOption

public void setCatManagementOption(CatManagementOption value)
Returns the catalog management option.

Parameters:
value - The catalog management option.

setCleanUpOption

public void setCleanUpOption(CleanUpOption value)
Returns the cleanup option.

Parameters:
value - The cleanup option.

setExpandedJCL

public void setExpandedJCL(boolean value)
Returns the expanded JCL property.

Parameters:
value - The expanded JCL property.

setUserSysOut

public void setUserSysOut(boolean value)
Returns the user sysout option.

Parameters:
value - The user sysout option.

setWLMCriticalJob

public void setWLMCriticalJob(boolean value)
Returns the WLM critical job property.

Parameters:
value - The WLM critical job property.

setWLMCriticalJobType

public void setWLMCriticalJobType(CriticalJobType value)
Sets the CriticalJobType option.

Parameters:
value - The CriticalJobType option.

setWLMPolicy

public void setWLMPolicy(WLMPolicy value)
Returns the WLM policy.

Parameters:
value - The WLM policy.

setWLMClass

public void setWLMClass(java.lang.String value)
Sets the WLM class.

Parameters:
value - The WLM class.

setSmoothingFactor

public void setSmoothingFactor(int value)
Returns the smoothing factor.

Parameters:
value - The smoothing factor.

setLimitForFeedback

public void setLimitForFeedback(int value)
Returns the limit for feedback.

Parameters:
value - The limit for feedback.

setHighestOkReturnCode

public void setHighestOkReturnCode(int value)
Returns the highest OK return code.

Parameters:
value - The highest OK return code.

setAutoSubmit

public void setAutoSubmit(boolean value)
Returns the auto submit option.

Parameters:
value - The auto submit option.

setAutoRelease

public void setAutoRelease(boolean value)
Returns the auto release option.

Parameters:
value - The auto release option.

setCancelIfLate

public void setCancelIfLate(boolean value)
Returns the cancel if late option.

Parameters:
value - The cancel if late option.

setAutoErrorCompletion

public void setAutoErrorCompletion(boolean value)
Returns the auto error completion option.

Parameters:
value - The auto error completion option.

setDeadlineWTO

public void setDeadlineWTO(boolean value)
Returns the deadline WTO option.

Parameters:
value - The deadline WTO option.

setRestartableOption

public void setRestartableOption(YesNoDefaultOption value)
Returns the restartable option.

Parameters:
value - The restartable option.

setReroutableOption

public void setReroutableOption(YesNoDefaultOption value)
Returns the reroutable option.

Parameters:
value - The reroutable option.

setOwningOpNumber

public void setOwningOpNumber(int value)
Sets the owning operation number.

Parameters:
value - The owning operation number.

setHasCentralizedScript

public void setHasCentralizedScript(boolean value)
Returns the has centralized script option.

Parameters:
value - The has centralized script option.

setUseExtendedTaskName

public void setUseExtendedTaskName(boolean value)
Sets the use extended task name option.

Parameters:
value - The use extended task name option.

setExtendedName

public void setExtendedName(java.lang.String value)
Sets the extended name.

Parameters:
value - The extended name.

setUseSchedulingEnvironment

public void setUseSchedulingEnvironment(boolean value)
Sets the use scheduling environment name option.

Parameters:
value - The use scheduling environment name option.

setSchedulingEnvironmentName

public void setSchedulingEnvironmentName(java.lang.String value)
Sets the scheduling environment name.

Parameters:
value - The scheduling environment name.

setCommandText

public void setCommandText(java.lang.String value)
Sets the command text (system automation).

Parameters:
value - The command text (system automation).

setAutomatedFunction

public void setAutomatedFunction(java.lang.String value)
Sets the automated function (system automation).

Parameters:
value - The automated function (system automation).

setSecurityElement

public void setSecurityElement(java.lang.String value)
Sets the security element (system automation).

Parameters:
value - The security element (system automation).

setCompletionInfo

public void setCompletionInfo(java.lang.String value)
Sets the completion info (system automation).

Parameters:
value - The completion info (system automation).

equals

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

Overrides:
equals in class JobDefinition
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 ZOSJobDefinition object.

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

toString

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

Overrides:
toString in class JobDefinition
Returns:
A text string including all ZOSJobDefinition fields.


Copyright © 2005 IBM All Rights Reserved.