7.4.2 Constants used by the unit list acquisition API

Organization of this subsection

(1) LowerType
(2) SearchTargetType
(3) MatchMethods
(4) UnitType
(5) GenerationType
(6) UnitStatus
(7) DelayType
(8) HoldPlan
(9) ReleaseInfoSearchMethods

(1) LowerType

This constant indicates whether to acquire the jobs under the relevant unit.

The following table lists and describes the character string constants for the LowerType constant.

Table 7‒54: List of the character string constants for the LowerType constant
Constant	Description
`YES`	All units (jobs) under the relevant unit will be acquired.
`NO`	Only the units directly under the relevant unit will be acquired.

To Page Top

(2) SearchTargetType

This constant indicates the range of information to be acquired.

The following table lists and describes the character string constants for the SearchTargetType constant.

Table 7‒55: List of the character string constants for the SearchTargetType constant
Constant	Description
`DEFINITION`	Only the unit definition will be acquired.
`DEFINITION_AND_STATUS`	The definition and status of the unit will be acquired, considering the execution status and generation of the unit.

To Page Top

(3) MatchMethods

This constant indicates the comparison method for a character string.

The following table lists and describes the character string constants for the MatchMethods constant.

Table 7‒56: List of the character string constants for the MatchMethods constant
Constant	Description
`NO`	This comparison method is not used as the search condition.
`EQ`	Completely match the value in the search condition. (perfect match).
`BW`	Begin with the value in the search condition. (begins-with match).
`EW`	End with the value in the search condition. (ends-with match).
`NE`	Do not match the value in the search condition. (no match).
`CO`	Contain the value in the search condition.
`NC`	Do not contain the value in the search condition.
`RE`	The value in the search condition is treated as the regular expression. For details about the regular expression, see Table 7-57.

Table 7‒57: Symbols that can be specified as a regular expression, specification examples, and example results of acquisition
Symbol	Description	Specification example	Example results of acquisition
`?`	Any one character	`A?`	`AB`, `A1`, `A?`, `A*`, `A\`
`?`	Any one character	`?E`	`DE`, `1E`, `?E`, `*E`, `\E`
`*`	Any character string	`B*`	`B`, `BC`, `B12`, `B?*\`
`\`	Uses the symbol immediately after this symbol as a character	`C\?`	`C?`

To Page Top

(4) UnitType

This constant indicates the unit type of the unit whose information will be acquired.

The following table lists and describes the character string constants for the UnitType constant.

Table 7‒58: List of the character string constants for the UnitType constant
Constant	Description
`NO`	Unit type is not considered in the search condition.
`GROUP`	Only the job group information will be acquired. Information of the units that have the following unit types will be acquired: Job group Planning group Manager job group
`ROOT`	Only the root jobnet information will be acquired. Information of the units that have the following unit types will be acquired: Root jobnet Root remote jobnet Root manager jobnet
`NET`	Only the jobnet information will be acquired. Information of the units that have the following unit types will be acquired: Root jobnet Root Remote jobnet Manager jobnet Nested jobnet Nested remote jobnet
`JOB`	Only the job information will be acquired. Information of the units that have the following unit types will be acquired: Standard job Event job Action job Custom job Passing information setting job HTTP connection job Flexible Job

To Page Top

(5) GenerationType

This constant indicates the generation of the unit whose information will be acquired.

The following table lists and describes the character string constants for the GenerationType constant.

Table 7‒59: List of the character string constants for the GenerationType constant
Constant	Description
`NO`	Generation is not considered in the search condition.
`STATUS`	The latest generation will be acquired. The generation to be acquired depends on the value set for the `VIEWSTATUSRANGE` environment setting parameter of the JP1/AJS3 - Manager you logged in. For details about the `VIEWSTATUSRANGE` environment setting parameter, see 20.4.2(70) VIEWSTATUSRANGE in the JP1/Automatic Job Management System 3 Configuration Guide.
`RESULT`	The generation in the latest result will be acquired.
`PERIOD`	The generations that exist in the specified period will be acquired.
`EXECID`	The generation for the specified execution ID will be acquired.

To Page Top

(6) UnitStatus

This constant indicates the status of the unit whose information will be acquired.

The following table lists and describes the character string constants for the UnitStatus constant.

Table 7‒60: List of the character string constants for the UnitStatus constant
Constant	Description
`NO`	Unit status is not considered in the search condition.
`UNREGISTERED`	Information of the units whose status is Not registered will be acquired.
`NOPLAN`	Information of the units whose status is Not sched. to exe. will be acquired.
`UNEXEC`	Information of the units whose status is Not executed + Ended will be acquired.
`BYPASS`	Information of the units whose status is Bypassed will be acquired.
`EXECDEFFER`	Information of the units whose status is Skipped so not exe. will be acquired.
`SHUTDOWN`	Information of the units whose status is Shutdown will be acquired.
`TIMEWAIT`	Information of the units whose status is Wait for start time will be acquired.
`TERMWAIT`	Information of the units whose status is Wait for prev. to end will be acquired.
`EXECWAIT`	Information of the units whose status is Waiting to execute will be acquired.
`QUEUING`	Information of the units whose status is Now queuing will be acquired.
`CONDITIONWAIT`	Information of the units whose status is Wait for start cond. will be acquired.
`HOLDING`	Information of the units whose status is Being held will be acquired.
`RUNNING`	Information of the units whose status is Now running will be acquired.
`WACONT`	Information of the units whose status is Ended with warning will be acquired.
`ABCONT`	Information of the units whose status is Running + Abend will be acquired.
`MONITORING`	Information of the units whose status is Now monitoring will be acquired.
`ABNORMAL`	Information of the units whose status is Ended abnormally will be acquired.
`INVALIDSEQ`	Information of the units whose status is Invalid exe. seq. will be acquired.
`INTERRUPT`	Information of the units whose status is Interrupted will be acquired.
`KILL`	Information of the units whose status is Killed will be acquired.
`FAIL`	Information of the units whose status is Failed to start will be acquired.
`UNKNOWN`	Information of the units whose status is Unknown end status will be acquired.
`MONITORCLOSE`	Information of the units whose status is Monitor terminated will be acquired.
`WARNING`	Information of the units whose status is Ended with warning will be acquired.
`NORMAL`	Information of the units whose status is Ended normally will be acquired.
`NORMALFALSE`	Information of the units whose status is Normal end + False will be acquired.
`UNEXECMONITOR`	Information of the units whose status is Unmonitored + Ended will be acquired.
`MONITORINTRPT`	Information of the units whose status is Interrupted monitoring will be acquired.
`MONITORNORMAL`	Information of the units whose status is Monitor-end normal will be acquired.
`GRP_WAIT`	Information of the units with one of the following statuses will be acquired: Wait for start time Wait for prev. to end Waiting to execute Now queuing Wait for start cond.
`GRP_RUN`	Information of the units with one of the following statuses will be acquired: Now running Running + Warning Running + Abend Now monitoring
`GRP_ABNORMAL`	Information of the units with one of the following statuses will be acquired: Ended abnormally Invalid exe. seq. Interrupted Killed Failed to start Unknown end status Monitor terminated
`GRP_NORMAL`	Information of the units with one of the following statuses will be acquired: Ended normally Normal end + False Unmonitored + Ended Interrupted monitoring Monitor-end normal

To Page Top

(7) DelayType

This constant indicates whether the start or end delay occurred for the unit whose information will be acquired.

The following table lists and describes the character string constants for the DelayType constant.

Table 7‒61: List of the character string constants for the DelayType constant
Constant	Description
`NO`	Whether a start or end delay occurred is not considered in the search condition.
`START`	Information of the units for which the start delay occurred will be acquired.
`END`	Information of the units for which the end delay occurred will be acquired.
`YES`	Information of the units for which the start or end delay occurred will be acquired.

To Page Top

(8) HoldPlan

This constant indicates whether there is a hold plan for the unit whose information will be acquired.

The following table lists and describes the character string constants for the HoldPlan constant.

Table 7‒62: List of the character string constants for the HoldPlan constant
Constant	Description
`NO`	Whether there is a hold plan is not considered in the search condition.
`PLAN_NONE`	Information of the units for which no hold plan exists will be acquired.
`PLAN_YES`	Information of the units for which a hold plan exists will be acquired.

To Page Top

(9) ReleaseInfoSearchMethods

This constant indicates the release ID of the unit whose information will be acquired.

The following table lists and describes the character string constants for the ReleaseInfoSearchMethods constant.

Table 7‒63: List of the character string constants for the ReleaseInfoSearchMethods constant
Constant	Description
`NO`	Release ID is not considered in the search condition.
`ID`	Release ID is considered in the search condition.

To Page Top