|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.JobDefinitionInPlan
com.ibm.tws.objects.plan.ZOSJobDefinitionInPlan
This object represents a TWS for z/OS job definition in plan.
The following syntax validation constraints must be met on ZOSJobDefinitionInPlan objects in ZOS 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 value is one of the following characters: | |||||||||||
'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O', 'P','Q','R','S','T','U','V','W','X','Y','Z' | ||||||||||||
Default value is ' ' | ||||||||||||
printClass | Valid value is one of the following characters: | |||||||||||
'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O', 'P','Q','R','S','T','U','V','W','X','Y','Z' | ||||||||||||
Default value is ' ' | ||||||||||||
formNumber | Not longer than 8 characters | |||||||||||
reportingAttribute | One of the following values exposed by the WorkstationReportingAttribute class: | |||||||||||
WorkstationReportingAttribute.AUTOMATIC | ||||||||||||
WorkstationReportingAttribute.MANUALSTARTSTOP | ||||||||||||
WorkstationReportingAttribute.MANUALCOMPLETIONONLY | ||||||||||||
WorkstationReportingAttribute.NONREPORTING | ||||||||||||
Default value is WorkstationReportingAttribute.NONREPORTING | ||||||||||||
catManagementOption | One of the following values exposed by the CatManagementOption class: | |||||||||||
CatManagementOption.NONE | ||||||||||||
CatManagementOption.IMMEDIATE | ||||||||||||
CatManagementOption.DEFERRED | ||||||||||||
Default value is CatManagementOption.NONE | ||||||||||||
cleanUpOption | One of the following values exposed by the CleanUpOption class: | |||||||||||
CleanUpOption.NONE | ||||||||||||
CleanUpOption.IMMEDIATE | ||||||||||||
CleanUpOption.AUTOMATIC | ||||||||||||
CleanUpOption.MANUAL | ||||||||||||
Default value is CleanUpOption.NONE | ||||||||||||
expandedJCL | Default value is false | |||||||||||
userSysOut | Default value is false | |||||||||||
wlmCriticalJob | Default value is false | |||||||||||
wlmCriticalJobType | Default value is CriticalJobType.NO | |||||||||||
wlmPolicy | One of the following values exposed by the WLMPolicy class: | |||||||||||
WLMPolicy.DEFAULT | ||||||||||||
WLMPolicy.LONGDURATION | ||||||||||||
WLMPolicy.DEADLINE | ||||||||||||
WLMPolicy.LATESTSTART | ||||||||||||
WLMPolicy.CONDITIONAL | ||||||||||||
Default value is WLMPolicy.DEADLINE | ||||||||||||
wlmClass | Not longer than 8 characters | |||||||||||
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 following values exposed by the YesNoDefaultOption class: | |||||||||||
YesNoDefaultOption.DEFAULT | ||||||||||||
YesNoDefaultOption.YES | ||||||||||||
YesNoDefaultOption.NO | ||||||||||||
Default value is YesNoDefaultOption.DEFAULT | ||||||||||||
reroutableOption | One of the following values exposed by the YesNoDefaultOption class: | |||||||||||
YesNoDefaultOption.DEFAULT | ||||||||||||
YesNoDefaultOption.YES | ||||||||||||
YesNoDefaultOption.NO | ||||||||||||
Default value is YesNoDefaultOption.DEFAULT | ||||||||||||
owningOpNumber | Valid range is from 0 to 255. | |||||||||||
Default value is 0 | ||||||||||||
hasCentralizedScript | Default value is false | |||||||||||
extendedName | Not longer than 54 characters | |||||||||||
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 |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
ZOSJobDefinitionInPlan()
Creates an empty ZOSJobDefinitionInPlan. |
|
ZOSJobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
Creates a ZOSJobDefinitionInPlan with the specified header. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this ZOSJobDefinitionInPlan 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. |
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). |
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 ZOSJobDefinitionInPlan object. |
void |
setAutoErrorCompletion(boolean value)
Returns the auto error completion option. |
java.lang.String |
setAutomatedFunction(java.lang.String value)
Sets the automated operator (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. |
java.lang.String |
setCommandText(java.lang.String value)
Sets the command text (system automation). |
java.lang.String |
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)
Set 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 |
setOwningOpNumber(int value)
Returns 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)
Set the scheduling environment name. |
java.lang.String |
setSecurityElement(java.lang.String value)
Sets the security element (system automation). |
void |
setUserSysOut(boolean value)
Returns the user sysout 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 WLM critical job property. |
void |
setWLMPolicy(WLMPolicy value)
Returns the WLM policy. |
java.lang.String |
toString()
Returns a string representation of this ZOSJobDefinitionInPlan object. |
Methods inherited from class com.ibm.tws.objects.plan.JobDefinitionInPlan |
---|
getAbendPromptId, getAbendPromptKey, getAbendPromptText, getDescription, getHeader, getId, getKey, getLockData, getModifyData, getName, getObjectHeader, getObjectKey, getRecoveryJob, getRecoveryJobId, getRecoveryJobKey, getTaskType, getWorkstationId, getWorkstationKey, isCommand, setAbendPromptId, setAbendPromptKey, setAbendPromptText, setCommand, setDescription, setHeader, setId, setKey, setName, setRecoveryJob, setRecoveryJobId, setRecoveryJobKey, setTaskType, setWorkstationId, setWorkstationKey |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public ZOSJobDefinitionInPlan()
public ZOSJobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
jobDefinitionHeader
- The job definition header.Method Detail |
public java.lang.String getJclName()
public char getJobClass()
public char getPrintClass()
public java.lang.String getFormNumber()
public WorkstationReportingAttribute getReportingAttribute()
public CatManagementOption getCatManagementOption()
public CleanUpOption getCleanUpOption()
public boolean getExpandedJCL()
public boolean getUserSysOut()
public boolean getWLMCriticalJob()
public CriticalJobType getWLMCriticalJobType()
public WLMPolicy getWLMPolicy()
public int getHighestOkReturnCode()
public boolean getAutoSubmit()
public boolean getAutoRelease()
public boolean getCancelIfLate()
public boolean getAutoErrorCompletion()
public boolean getDeadlineWTO()
public YesNoDefaultOption getRestartableOption()
public YesNoDefaultOption getReroutableOption()
public long getOwningOpNumber()
public boolean getHasCentralizedScript()
public java.lang.String getExtendedName()
public java.lang.String getSchedulingEnvironmentName()
public java.lang.String getCommandText()
public java.lang.String getAutomatedFunction()
public java.lang.String getSecurityElement()
public java.lang.String getCompletionInfo()
public java.lang.String getWLMClass()
public void setJclName(java.lang.String value)
value
- The JCL name.public void setJobClass(char value)
value
- The job class.public void setPrintClass(char value)
value
- The print class.public void setFormNumber(java.lang.String value)
value
- The form number.public void setReportingAttribute(WorkstationReportingAttribute value)
value
- The reporting attribute.public void setCatManagementOption(CatManagementOption value)
value
- The catalog management option.public void setCleanUpOption(CleanUpOption value)
value
- The cleanup option.public void setExpandedJCL(boolean value)
value
- The expanded JCL property.public void setUserSysOut(boolean value)
value
- The user sysout option.public void setWLMCriticalJob(boolean value)
value
- The WLM critical job property.public void setWLMCriticalJobType(CriticalJobType value)
value
- The CriticalJobType option.public void setWLMPolicy(WLMPolicy value)
value
- The WLM policy.public void setHighestOkReturnCode(int value)
value
- The highest OK return code.public void setAutoSubmit(boolean value)
value
- The auto submit option.public void setAutoRelease(boolean value)
value
- The auto release option.public void setCancelIfLate(boolean value)
value
- The cancel if late option.public void setAutoErrorCompletion(boolean value)
value
- The auto error completion option.public void setDeadlineWTO(boolean value)
value
- The deadline WTO option.public void setRestartableOption(YesNoDefaultOption value)
value
- The restartable option.public void setReroutableOption(YesNoDefaultOption value)
value
- The reroutable option.public void setOwningOpNumber(int value)
value
- The owning operation number.public void setHasCentralizedScript(boolean value)
value
- The has centralized script option.public void setExtendedName(java.lang.String value)
value
- The extended name.public void setSchedulingEnvironmentName(java.lang.String value)
value
- The scheduling environment name.public java.lang.String setCommandText(java.lang.String value)
value
- The command text (system automation).public java.lang.String setAutomatedFunction(java.lang.String value)
value
- The automated operator (system automation).public java.lang.String setSecurityElement(java.lang.String value)
value
- The security element (system automation).public java.lang.String setCompletionInfo(java.lang.String value)
value
- The completion info (system automation).public void setWLMClass(java.lang.String value)
value
- The WLM Class.public boolean equals(java.lang.Object object)
equals
in class JobDefinitionInPlan
object
- The object to be compared with this one.
public int hashCode()
hashCode
in class JobDefinitionInPlan
public java.lang.String toString()
toString
in class JobDefinitionInPlan
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |