JP1 Version 10　JP1/Automatic Job Management System 3 - Software Development Kit　APIリファレンス

文法・操作書

3021-3-119-10

前書き

対象製品

適用OSのバージョン，JP1/Automatic Job Management System 3 - Software Development Kitが前提とするサービスパックやパッチなどの詳細については，リリースノートで確認してください。

P-2A12-32A4 JP1/Automatic Job Management System 3 - Software Development Kit 10-10　（適用OS：Windows 8，Windows Server 2012，Windows 7，Windows Server 2008，Windows Server 2003）

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

AIXは，米国およびその他の国におけるInternational Business Machines Corporationの商標です。

Itaniumは，アメリカ合衆国およびその他の国におけるIntel Corporationの商標です。

Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。

UNIXは，The Open Groupの米国ならびに他の国における登録商標です。

Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名、製品名は、それぞれの会社の商標もしくは登録商標です。

マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記

製品名

Windows 7

Microsoft(R) Windows(R) 7 Professional

Microsoft(R) Windows(R) 7 Enterprise

Microsoft(R) Windows(R) 7 Ultimate

Windows 8

Windows(R) 8

Windows(R) 8 Pro

Windows(R) 8 Enterprise

Windows Server 2003

Windows Server 2003

Microsoft(R) Windows Server(R) 2003, Enterprise Edition

Microsoft(R) Windows Server(R) 2003, Standard Edition

Windows Server 2003 R2

Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition

Microsoft(R) Windows Server(R) 2003 R2, Standard Edition

Windows Server 2003（x64）

Microsoft(R) Windows Server(R) 2003, Enterprise x64 Edition

Microsoft(R) Windows Server(R) 2003, Standard x64 Edition

Windows Server 2003 R2（x64）

Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition

Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition

Windows Server 2008

Windows Server 2008

Microsoft(R) Windows Server(R) 2008 Enterprise

Microsoft(R) Windows Server(R) 2008 Standard

Windows Server 2008 R2

Microsoft(R) Windows Server(R) 2008 R2 Datacenter

Microsoft(R) Windows Server(R) 2008 R2 Enterprise

Microsoft(R) Windows Server(R) 2008 R2 Standard

Windows Server 2012

Microsoft(R) Windows Server(R) 2012 Standard

Microsoft(R) Windows Server(R) 2012 Datacenter

Windows 8，Windows Server 2012，Windows 7，Windows Server 2008，およびWindows Server 2003を総称してWindowsと表記することがあります。

発行

2013年9月　3021-3-119-10

著作権

Copyright (C) 2012, 2013, Hitachi, Ltd.

Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.

変更内容

変更内容（3021-3-119-10）

追加・変更内容

変更個所

記載内容を変更した。詳細については，付録Dを参照のこと。

付録D

はじめに

このマニュアルは，JP1/Automatic Job Management System 3 - Software Development Kit（以降，JP1/AJS3 - SDKと省略します）のAPIリファレンスについて説明したものです。JP1/AJS3 - SDKの設計・構築について解説した，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」の内容を踏まえた上でご利用ください。

対象読者

このマニュアルはJP1/AJS3 - SDKを使ってシステムを開発するソフトウェア開発者の方を対象としています。また，次の知識を持っていることを前提としています。

JP1/AJS3およびJP1/Baseの機能に関する知識

Javaプログラミングでのアプリケーション開発に関する十分な知識

マニュアルの構成

このマニュアルは，次に示す編から構成されています。

第１編 リファレンス編

JP1/AJS3 - SDKが提供するAPIについてリファレンス形式で説明しています。

第２編 メッセージ編

JP1/AJS3 - SDKが出力するメッセージIDの付いたメッセージについて説明しています。

読書手順

このマニュアルは，利用目的に合わせて章または節を選択して読むことができます。利用目的別にお読みいただくことをお勧めします。

マニュアルを読む目的

記述個所

JP1/AJS3 - SDKが提供するAPIの概要について知りたい。

1章

JP1/AJS3 - SDKが提供する各APIのリファレンス情報について知りたい。

2章，3章，4章，付録A，付録B，付録C

JP1/AJS3 - SDKが出力するメッセージについて知りたい。

5章

このマニュアルの変更内容について知りたい。

付録D

このマニュアルの参考情報について知りたい。

付録E

JP1/AJS3 - SDKマニュアルの使い分けについて

JP1/AJS3 - SDKのマニュアルは2冊に分かれています。次に示す表でマニュアルの記載内容をご確認の上，利用目的に合わせてマニュアルをお読みください。

マニュアル名

記載内容

JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド

JP1/AJS3 - SDKの機能概要

JP1/AJS3 - SDKの設計および構築

ユーザーアプリケーションの設計および開発

トラブルシューティング

JP1/A utomatic J ob Management S ystem 3 - Software Development Kit APIリファレンス

APIの文法

メッセージ

第1編　リファレンス編

1　概要

この章では，JP1/AJS3 - SDKが提供するAPIの概要について説明します。

1.1　各クラスの概要

1.1.1　API処理クラス

JP1/AJS3 - SDKが提供するAPI処理クラスのクラスおよびインターフェースを次の表に示します。

表1‒1　API処理クラスのクラス/インターフェース一覧

クラス名/インターフェース名

説明

AjsCdFactoryクラス

AjsCdインターフェースを実装したクラスインスタンスを生成，取得，破棄するためのクラスです。

AjsCdインターフェース

AjsCdApiインターフェースを実装したクラスインスタンスを生成，取得，破棄するためのインターフェースです。

AjsCdApiインターフェース

JP1/AJS3 - Managerを操作するためのAPIのインターフェースです。

1.1.2　データ型クラス

JP1/AJS3 - SDKが提供するデータ型クラスのクラス，およびインターフェースの一覧を次の表に示します。

表1‒2　データ型クラスのクラス/インターフェース一覧

クラス名/インターフェース名

説明

ユニット情報インターフェース

（AjsCdUnitInfo）

searchUnitメソッド，getCurrentStatusesUnderJobGroupメソッド，getDefinitionsUnderJobnetメソッド，getStatusesUnderJobnetメソッド，getScheduleメソッド，およびgetJobnetSummaryメソッドで取得したユニット情報を保持するインターフェースです。

ユニットの実行状態および実行結果の詳細情報インターフェース

（AjsCdUnitStatus）

searchUnitメソッド，getUnitStatusメソッド，getCurrentStatusesUnderJobGroupメソッド，getStatusesUnderJobnetメソッド，getScheduleメソッド，およびgetJobnetSummaryメソッドで取得したユニットの実行状態および実行結果の詳細情報を保持するインターフェースです。

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）

searchUnit メソッド，getJobnetSummary メソッド，およびgetJobnetReleaseInfoメソッドで取得したリリース情報を保持するインターフェースです。

起動条件クラス

（AjsCdStartCondition）

registerImmediateExecメソッドの引数として，起動条件を指定するクラスです。

マクロ変数リストクラス

（AjsCdMacroVariableList）

registerImmediateExecメソッド，registerPlannedExecメソッド，registerFixedExecメソッド，およびaddExecScheduleメソッドの引数として，実行登録時のマクロ変数を指定するクラスです。

マクロ変数インターフェース

（AjsCdMacroVariable）

getInheritResultメソッドで取得したクラスを実装するためのインターフェースです。

ユニット検索条件クラス

（AjsCdSearchCondition）

searchUnitメソッドの引数として，取得するユニット一覧の取得条件を設定するクラスです。

ユニット検索結果インターフェース

（AjsCdSearchResult）

searchUnitメソッドで取得したユニットの検索結果を保持するためのインターフェースです。

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）

getCurrentStatusesUnderJobGroupメソッドの引数として，取得オプションを設定するクラスです。

取得項目オプションクラス（AjsCdGetStatusDetailOption）

取得オプション中の取得項目を設定するクラスです。

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）

getCurrentStatusesUnderJobGroupメソッドの取得結果を保持するインターフェースです。

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）

getCurrentStatusesUnderJobGroupメソッドで取得したユニットの定義情報，最新状態情報，および最新結果情報を保持するインターフェースです。

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）

getDefinitionsUnderJobnetメソッドの取得結果を保持するインターフェースです。

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）

getStatusesUnderJobnetメソッドの引数として，取得オプションを設定するクラスです。

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）

getStatusesUnderJobnetメソッドの取得結果を保持するインターフェースです。

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）

getRelationsUnderJobnetメソッドの取得結果を保持するインターフェースです。

関連線情報インターフェース（AjsCdUnitRelation）

getRelationsUnderJobnetメソッドで取得した関連線情報を保持するインターフェースです。

予実績情報取得オプションクラス（AjsCdGetScheduleOption）

getScheduleメソッドの引数として，取得オプションを設定するクラスです。

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）

getScheduleメソッドの取得結果を保持するインターフェースです。

世代単位の予実績情報インターフェース（AjsCdSchedule）

getScheduleメソッドで取得した世代単位の予実績情報を保持するインターフェースです。

カレンダー情報インターフェース（AjsCdCalendar）

getCalendarメソッドで取得したカレンダー情報を保持するインターフェースです。

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）

getJobnetSummaryメソッドの引数として，取得オプションを設定するクラスです。

サマリー情報共通インターフェース（AjsCdJobnetSummary）

サマリー情報を保持するインターフェースです。

サマリー情報全体インターフェース（AjsCdTotalSummary）

全世代分のサマリー情報を保持するインターフェースです。

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）

1世代分のサマリー情報を保持するインターフェースです。

スケジューラーサービス定義インターフェース

（AjsCdSchServiceDef）

enumSchServiceメソッドで取得したクラスを実装するためのインターフェースです。

スケジューラーサービス情報インターフェース

（AjsCdSchServiceInfo）

getSchServiceInfoメソッドで取得したクラスを実装するためのインターフェースです。

メソッドで取得したスケジューラーサービスの情報が格納されています。

JP1/AJS3 - Manager情報インターフェース

（AjsCdAJSManagerInfo）

getAJSManagerInfoメソッドで取得したクラスを実装するためのインターフェースです。

メソッドで取得したJP1/AJS3 - Managerの情報が格納されています。

1.1.3　例外クラス

JP1/AJS3 - SDKが提供する例外クラスのクラス一覧を次の表に示します。

表1‒3　例外クラスのクラス一覧

クラス名/インターフェース名

説明

AjsCdException例外クラス

JP1/AJS3 - SDKの共通の例外クラス，およびJP1/AJS3 - SDKが提供する例外クラスのスーパークラスです。また，初期化関連エラー，システムエラー，内部エラーなどが発生した場合に報告される例外クラスです。

AjsCdAJSManagerException例外クラス

接続先のJP1/AJS3 - Managerでエラーが発生した場合に報告される例外クラスです。

AjsCdInvalidTokenException例外クラス

接続先のJP1/AJS3 - Manager で認証情報のエラーが発生した場合に報告される例外クラスです。再認証が必要となります。

AjsCdApiParameterException例外クラス

AjsCdApiSequenceException例外クラス

AjsCdApiCancelException例外クラス

JP1/AJS3 - SDKのAPI で引数エラー，シーケンスエラー，API キャンセルが発生した場合に報告される例外クラスです。

AjsCdApiException例外クラス

JP1/AJS3 - SDKのAPIの共通の例外クラスです。JP1/AJS3 - Managerとの接続関連のエラーなどが発生した場合に報告される例外クラスです。

AjsCdReturnCodeクラス

JP1/AJS3 - SDKのエラーリターンコード情報を保持するクラスです。

JP1/AJS3 - SDKが提供するAPIで例外が発生した場合，Javaの重大な問題を示すjava.lang.Errorを除き，すべて例外クラス「AjsCdException例外クラス」を送出します。AjsCdException例外クラスが送出された場合は，API要求の操作結果，取得結果などの値は保証されません。

なお，例外「なし」と記載されている場合でも，Javaの重大な問題を示すjava.lang.Errorが発生する可能性があります。

1.2　各クラスのメソッド

JP1/AJS3 - SDKが提供する各クラスのメソッドについて説明します。

1.2.1　API処理クラスのメソッド一覧

API処理クラスのメソッド一覧を次の表に示します。

表1‒4　API処理クラスのメソッド一覧

項番

クラス名/インターフェース名

メソッド名

機能

1

AjsCdFactoryクラス

getInstance

インスタンスの取得

2

createAjsCd

クラスインスタンスの生成

3

getAjsCd

生成済みのクラスインスタンスの取得

4

destroyAjsCd

クラスインスタンスの破棄

5

AjsCdインターフェース

createAjsCdApi

クラスインスタンスの生成

6

getAjsCdApi

生成済みのクラスインスタンスの取得

7

destroyAjsCdApi

クラスインスタンスの破棄

8

AjsCdApiインターフェース

login

接続先JP1/AJS3 - Managerへのログイン

9

logout

ログイン中JP1/AJS3 - Managerからのログアウト

10

logoutAll

loginメソッドの呼び出しにより，ログイン中のすべてのJP1/AJS3 - Managerのログアウト処理の実行

11

registerImmediateExec

ジョブネットの即時実行登録

12

registerPlannedExec

ジョブネットの計画実行登録

13

registerFixedExec

ジョブネットの確定実行登録

14

cancelRegistration

ジョブネットの実行登録解除

15

addExecSchedule

ジョブネットの実行予定の追加

16

changeStartTime

ジョブネットの実行開始日時の変更

17

execImmediate

実行予定の存在するジョブネットの即時実行

18

cancelExecSchedule

ジョブネット，およびジョブの実行の一時停止

19

restoreStartTime

ジョブネットの実行開始日時の変更の解除

20

changeHold

ジョブネット，およびジョブの実行保留の設定，保留の解除

21

changeDelayMonitor

ジョブネットの遅延監視日時の一時的変更

22

changeStatus

ジョブの状態変更

23

interrupt

ジョブネットの中断

24

kill

実行中のジョブネット，およびジョブの強制終了

25

rerun

ジョブネット，およびジョブの再実行

26

searchUnit

ユニット一覧情報の取得

27

cancelSearch

実行中のsearchUnitメソッドでのユニット一覧取得の中止

28

getUnitStatus

ジョブネット，およびジョブの実行状態の詳細情報の取得，実行結果の詳細情報の取得

29

getExecResultDetails

ジョブの実行結果詳細の取得

30

getInheritResult

引き継ぎ結果の取得

31

getCurrentStatusesUnderJobGroup

ジョブグループ直下のユニットのユニット定義情報，最新状態情報，および最新結果情報の取得

32

getDefinitionsUnderJobnet

ジョブネット直下のユニット定義情報の取得

33

getStatusesUnderJobnet

ジョブネット直下のユニット状態情報の取得

34

getRelationsUnderJobnet

ジョブネット直下の関連線情報の取得

35

getSchedule

ジョブネットの予実績情報の取得

36

cancelGetSchedule

実行中のgetScheduleメソッドでの予実績情報取得の中止

37

getCalendar

カレンダー情報の取得

38

getJobnetSummary

サマリー情報の取得

39

getJobnetReleaseInfo

リリース情報の取得

40

enumSchService

スケジューラーサービスの一覧の取得

41

getSchServiceInfo

スケジューラーサービスの情報の取得

42

getAJSManagerInfo

JP1/AJS3 - Managerの情報取得

43

getCharCode

APIが使用する文字コードの取得

44

setCharCode

APIが使用する文字コードの設定

1.2.2　データ型クラスのメソッド一覧

データ型クラスのメソッド一覧を次の表に示します。

表1‒5　データ型クラスのメソッド一覧

項番

クラス名/インターフェース名

メソッド名

機能

1

ユニット情報インターフェース（AjsCdUnitInfo）

getUnitName

ユニット名称（完全名）の取得

2

getSimpleUnitName

ユニット名称（単体名）の取得

3

getUnitComment

ユニットのコメントの取得

4

getUnitType

ユニット種別の取得

5

getCustomJobType

カスタムジョブの種別の取得

6

getOwner

所有者名の取得

7

getJP1ResourceGroup

JP1資源グループ名の取得

8

getExecAgent

実行エージェント名の取得

9

getExecFileName

実行ファイル名の取得

10

getParameters

パラメーター情報の取得

11

getRegisterStatus

ユニットの登録状態の取得

12

getUnitID

ユニットIDの取得

13

getUnitStatus

ユニットの実行状態，および実行結果の詳細情報を取得

14

isScenarioUnit

JP1/AJS2 - Scenario Operationから登録されたシナリオかどうかを取得

15

isRecoveryUnit

ユニットにリカバリー属性が設定されているかどうかを取得

16

getHorizontalPosition

ユニットの水平方向の位置情報の取得

17

getVerticalPosition

ユニットの垂直方向の位置情報の取得

18

getJobnetReleaseInfo

リリース情報の取得

19

isWait

待ち合わせ条件付きユニットかどうかを取得

20

isRetry

リトライ設定のありなしを取得

21

getMaximumRetryTimes

最大リトライ回数の取得

22

getRetryInterval

リトライ間隔の取得

23

isJobnetReleaseUnit

リリース登録されているかどうかを取得

24

ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）

getUnitName

ユニット名称（完全名）の取得

25

getSimpleUnitName

ユニット名称（単体名）の取得

26

getExecID

実行IDの取得

27

getStatus

状態の取得

28

getSchStartTime

開始予定日時の取得

29

getStartTime

開始日時の取得

30

getReStartTime

再実行開始日時の取得

31

getEndTime

終了日時の取得

32

getStartDelayStatus

自身の開始遅延有無の取得

33

getNestStartDelayStatus

配下の開始遅延有無の取得

34

getEndDelayStatus

自身の終了遅延有無の取得

35

getNestEndDelayStatus

配下の終了遅延有無の取得

36

getStartDelayTime

開始遅延日時の取得

37

getEndDelayTime

終了遅延日時の取得

38

getChangeType

計画一時変更の有無の取得

39

getHoldAttr

保留属性の取得

40

getRegisterTime

ジョブ登録日時の取得

41

getJobNumber

ジョブ番号の取得

42

getRetCode

終了コードの取得

43

getExecHost

実行ホスト名の取得

44

getHoldPlan

保留予定の有無の取得

45

getExecutionType

登録種別の取得

46

getStartConditionTimes

起動条件の有効範囲の回数の取得

47

getStartConditionPeriod

起動条件の有効範囲の時間の取得

48

getStartConditionPeriodType

起動条件の有効範囲の時間の種別の取得

49

getRetryStatus

リトライ状態の取得

50

getRetryTimes

リトライ実行回数の取得

51

getStatusInSummary

サマリーでカウントする状態の取得

52

getExecDateBaseTime

ルートジョブネットの実行日の基準時刻の取得

53

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）

getReleaseID

リリースIDの取得

54

getReleaseTime

リリース日時の取得

55

getReleaseComment

リリースコメントの取得

56

getReleaseStatus

リリース状態の取得

57

getSourceUnitName

リリース元ジョブネット完全名の取得

58

起動条件クラス（AjsCdStartCondition）

createAjsCdStartCondition

AjsCdStartConditionクラスのインスタンスの生成

59

setTimes

起動条件の有効範囲の回数の設定

60

setPeriod

起動条件の有効範囲の時間の設定

61

setPeriodType

起動条件の有効範囲の時間の種別の設定

62

getTimes

起動条件の有効範囲の回数の取得

63

getPeriod

起動条件の有効範囲の時間の取得

64

getPeriodType

起動条件の有効範囲の時間の種別の取得

65

マクロ変数リストクラス（AjsCdMacroVariableList）

createAjsCdMacroVariableList

AjsCdMacroVariableListクラスのインスタンスの生成

66

addMacroVariable

マクロ変数の追加，設定

67

getMacroVariableList

マクロ変数インターフェース（AjsCdMacroVariable）のリストの取得

68

マクロ変数インターフェース（AjsCdMacroVariable）

getName

マクロ変数名の取得

69

getValue

引き継ぎ結果の取得

70

ユニット検索条件クラス（AjsCdSearchCondition）

createAjsCdSearchCondition

AjsCdSearchConditionクラスのインスタンスの生成

71

setSearchLocation

取得対象ユニットの上位ユニットの名称の設定

72

setSearchLowerUnits

取得対象ユニットの階層の設定

73

setSearchTarget

取得対象の範囲の設定

74

setUnitName

取得対象ユニットの名称の設定

75

setUnitNameMatchMethods

ユニット名の比較方法の設定

76

setExecID

取得対象ユニットの実行IDの設定

77

setUnitType

取得対象ユニットの種別の設定

79

setGeneration

取得対象ユニットの世代の設定

79

setPeriodBegin

期間を指定して対象世代を指定する場合の開始日時の設定

80

setPeriodEnd

期間を指定して対象世代を指定する場合の終了日時の設定

81

setStatus

取得対象ユニットの状態の設定

82

setDelayStatus

取得対象ユニットの遅延状態の設定

83

setHoldAttr

取得対象ユニットの保留状態の設定

84

setUnitComment

取得対象ユニットのコメントの設定

85

setUnitCommentMatchMethods

コメントの比較方法の設定

86

setExecHost

取得対象ユニットの実行ホスト名の設定

87

setExecHostMatchMethods

実行ホスト名の比較方法の設定

88

setResultMax

取得結果の最大数の設定

89

setReleaseID

取得対象ユニットのリリースIDの設定

90

setReleaseInfoSearchMethods

リリース情報の取得方法の設定

91

getSearchLocation

取得対象ユニットの上位ユニットの名称の取得

92

getSearchLowerUnits

取得対象ユニットの階層の取得

93

getSearchTarget

取得対象の範囲の取得

94

getUnitName

取得対象ユニットの名称の取得

95

getUnitNameMatchMethods

ユニット名の比較方法の取得

96

getExecID

取得対象ユニットの実行IDの取得

97

getUnitType

取得対象ユニットの種別の取得

98

getGeneration

取得対象ユニットの世代の取得

99

getPeriodBegin

期間を指定して対象世代を指定する場合の開始日時の取得

100

getPeriodEnd

期間を指定して対象世代を指定する場合の終了日時の取得

101

getStatus

取得対象ユニットの状態の取得

102

getDelayStatus

取得対象ユニットの遅延状態の取得

103

getHoldAttr

取得対象ユニットの保留状態の取得

104

getUnitComment

取得対象ユニットのコメントの取得

105

getUnitCommentMatchMethods

コメントの比較方法の取得

106

getExecHost

取得対象ユニットの実行ホスト名の取得

107

getExecHostMatchMethods

実行ホスト名の比較方法の取得

108

getResultMax

取得結果の最大数の取得

109

getReleaseID

取得対象ユニットのリリースIDの取得

110

getReleaseInfoSearchMethods

リリース情報の取得方法の取得

111

ユニット検索結果インターフェース（AjsCdSearchResult）

getUnitInfo

検索結果のリストの取得

112

isAll

すべての検索結果が取得できたかを取得

113

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）

createAjsCdGetCurrentStatusesUnderJobGroupOption

AjsCdGetCurrentStatusesUnderJobGroupOptionクラスのインスタンスの生成

114

setGetHoldPlanType

「保留予定の有無を取得するかどうか」の設定

115

setStatusItem

「最新状態情報で取得する情報」の設定

116

setResultItem

「最新結果情報で取得する情報」の設定

117

getGetHoldPlanType

「保留予定の有無を取得するかどうか」の取得

118

getStatusItem

「最新状態情報で取得する情報」の取得

119

getResultItem

「最新結果情報で取得する情報」の取得

120

取得項目オプションクラス（AjsCdGetStatusDetailOption）

createAjsCdGetStatusDetailOption

AjsCdGetStatusDetailOptionクラスのインスタンスの生成

121

setGetStartTimeOption

「開始日時を取得するかどうか」の設定

122

setGetEndTimeOption

「終了日時を取得するかどうか」の設定

123

setGetChangeTypeOption

「計画一時変更の有無を取得するかどうか」の設定

124

setGetStartDelayOption

「開始遅延日時を取得するかどうか」の設定

125

setGetEndDelayOption

「終了遅延日時を取得するかどうか」の設定

126

setGetExecutionTypeOption

「登録種別を取得するかどうか」の設定

127

setGetStartConditionOption

「起動条件の情報を取得するかどうか」の設定

128

isGetStartTimeOption

「開始日時を取得するかどうか」を取得

129

isGetEndTimeOption

「終了日時を取得するかどうか」を取得

130

isGetChangeType

「計画一時変更の有無を取得するかどうか」を取得

131

isGetStartDelayOption

「開始遅延日時を取得するかどうか」を取得

132

isGetEndDelayOption

「終了遅延日時を取得するかどうか」を取得

133

isGetExecutionTypeOpion

「登録種別を取得するかどうか」を取得

134

isGetStartConditionOption

「起動条件の情報を取得するかどうか」を取得

135

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）

getCurrentStatusesUnderJobGroup

ユニットの定義情報，最新状態情報，および最新結果情報の取得

136

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）

getUnitInfo

ユニットの定義情報の取得

137

getStatusInfo

ユニットの最新状態の詳細情報の取得

138

getResultInfo

ユニットの最新結果の詳細情報の取得

139

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）

getUnitInfo

ユニットの定義情報の取得

140

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）

createAjsCdGetStatusesUnderJobnetOption

AjsCdGetStatusesUnderJobnetOptionクラスのインスタンスの生成

141

setGetHoldPlanType

「保留予定の有無を取得するかどうか」の設定

142

getGetHoldPlanType

「保留予定の有無を取得するかどうか」の取得

143

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）

getUnitInfo

ユニットの状態情報の取得

144

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）

getUnitRelationList

関連線情報の取得

145

関連線情報インターフェース（AjsCdUnitRelation）

getPreceding

先行ユニットのユニットIDの取得

146

getSucceeding

後続ユニットのユニットIDの取得

147

getRelationType

関連線の種別の取得

148

予実績情報取得オプションクラス（AjsCdGetScheduleOption）

createAjsCdGetScheduleOption

AjsCdGetScheduleOptionクラスのインスタンスの生成

149

setGetHoldPlanType

「保留予定の有無を取得するかどうか」の設定

150

setSimulation

「実行シミュレーションを行うかどうか」を設定

151

setFirstExecutionTime

初回実行時間の設定

152

setGetChangeTypeOption

「計画一時変更の有無を取得するかどうか」の設定

153

setGetStartConditionOption

「起動条件の情報を取得するかどうか」の設定

154

getGetHoldPlanType

「保留予定の有無を取得するかどうか」の取得

155

isSimulation

「実行シミュレーションを行うどうか」を取得

156

getFirstExecutionTime

初回実行時間の取得

157

isGetChangeTypeOption

「計画一時変更の有無を取得するかどうか」を取得

158

isGetStartConditionOption

「起動条件の情報を取得するかどうか」を取得

159

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）

getScheduleInGenerationList

ユニットの予実績情報の取得

160

世代単位の予実績情報インターフェース（AjsCdSchedule）

getUnitInfo

世代単位の予実績情報の取得

161

カレンダー情報インターフェース（AjsCdCalendar）

getBaseType

基準日の指定値の取得

162

getMonthType

カレンダーの月区分の取得

163

getBaseDate

基準日の日付の取得

164

getBaseWeek

基準日の週の取得

165

getBaseDay

基準日の曜日の取得

166

getBaseTime

基準時刻の取得

167

getStartDay

getDayListメソッドで取得した情報の開始日の取得

168

getDayList

運用日，休業日の情報の取得

169

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）

createAjsCdGetSummaryOption

AjsCdGetSummaryOptionクラスのインスタンスの生成

167

setType

取得対象とする情報の種類の設定

168

setGetHoldPlanType

「保留予定の有無を取得するかどうか」の設定

169

setFirstExecutionTime

初回実行時間の設定

170

getType

取得対象とする情報の種類の取得

171

getGetHoldPlanType

「保留予定の有無を取得するかどうか」の取得

172

getFirstExecutionTime

初回実行時間の取得

173

サマリー情報共通インターフェース（AjsCdJobnetSummary）

getSchEndTime

終了予定日時の取得

174

getAbnormalCount

異常終了したユニット数の取得

175

getWarningCount

警告終了したユニット数の取得

176

getDelayCount

遅延したユニット数の取得

177

getHoldCount

保留中のユニット数の取得

178.

getWaitCount

開始待ちのユニット数の取得

179

getRunCount

実行中のユニット数の取得

180

getNormalCount

正常終了したユニット数の取得

181

getScheduleCount

予定ユニット数の取得

182

サマリー情報全体インターフェース（AjsCdTotalSummary）

getGenerationNumber

世代数の取得

183

getSchEndTime

終了予定日時の取得

184

getAbnormalCount

異常終了したユニット数の取得

185

getWarningCount

警告終了したユニット数の取得

186

getDelayCount

遅延したユニット数の取得

187

getHoldCount

保留中のユニット数の取得

188

getWaitCount

開始待ちのユニット数の取得

189

getRunCount

実行中のユニット数の取得

190

getNormalCount

正常終了したユニット数の取得

191

getScheduleCount

予定ユニット数の取得

192

getSummaryInGenerationList

1世代分のサマリー情報のリストの取得

193

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）

getSchEndTime

終了予定日時の取得

194

getAbnormalCount

異常終了したユニット数の取得

195

getWarningCount

警告終了したユニット数の取得

196

getDelayCount

遅延したユニット数の取得

197

getHoldCount

保留中のユニット数の取得

198

getWaitCount

開始待ちのユニット数の取得

199

getRunCount

実行中のユニット数の取得

200

getNormalCount

正常終了したユニット数の取得

201

getScheduleCount

予定ユニット数の取得

202

getExecID

実行IDの取得

203

getUnitInfo

ユニット詳細情報のリストの取得

204

スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）

getServiceName

スケジューラーサービス名の取得

205

スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）

getCharCode

文字コードの取得

206

getDeflenType

指定できる文字数を，シフトJIS環境の場合に指定できる文字数と同じにするかどうかの設定の取得

207

getDBType

スケジューラーサービスのDB種別の取得

208

isOperationNet

オペレーションネット用のスケジューラーサービス（JP1/IM - Planning Operationで管理される）かどうかの取得

209

JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）

getVersion

JP1/AJS3 - Managerのバージョン情報の取得

210

getOSType

JP1/AJS3 - ManagerのOS種別の取得

211

getOSDetail

JP1/AJS3 - ManagerのOS詳細の取得

212

getOSArchitecture

JP1/AJS3 - ManagerのOSアーキテクチャの取得

213

getLinuxVersion

JP1/AJS3 - ManagerのLinuxのバージョンの取得

214

getDBConfig

JP1/AJS3 - Managerのデータベース構成の取得

1.2.3　例外クラスのメソッド一覧

例外クラスのメソッド一覧を次の表に示します。

表1‒6　例外クラスのメソッド一覧

項番

クラス名/インターフェース名

メソッド名

機能

1

AjsCdException例外クラス

AjsCdAJSManagerException例外クラス

AjsCdInvalidTokenException例外クラス

AjsCdApiParameterException例外クラス

AjsCdApiSequenceException例外クラス

AjsCdApiCancelException例外クラス

AjsCdApiException例外クラス

getReturnCode

エラーリターンコード情報の取得

2

getMessage

エラー内容を示すメッセージテキストの取得

3

AjsCdException例外クラス

AjsCdApiParameterException例外クラス

AjsCdApiException例外クラス

getCause

このエラーの要因となった例外クラスの返却（存在しない場合はnullを返却）

4

AjsCdInvalidTokenException例外クラス

getManager

ログイン情報が無効となったJP1/AJS3 - Managerのホスト名の取得

5

getUserName

ログイン情報が無効となったJP1ユーザー名の取得

6

AjsCdReturnCodeクラス

getReturnCode

リターンコード情報の終了コードの取得

7

getDetailCode

リターンコード情報の詳細コードの取得

1.3　APIの記述形式

1.3.1　クラス，インターフェース

クラスまたはインターフェースの概要，クラス定義，パッケージ名について説明しています。上位のクラスで定義されているメソッドについては，定義元のクラスを参照してください。

1.3.2　メソッド

クラスまたはインターフェースの説明に続けて，そのクラスまたはインターフェースに定義されているメソッドについて説明しています。上位のクラスから継承されるメソッドについては，継承元のクラスのメソッドの説明を参照してください。

メソッドで説明する項目の詳細は次のとおりです。

(1)　機能

対象となるメソッドの機能について説明します。

(2)　形式

対象となるメソッドの記述形式を示します。

(3)　実行権限

対象となるメソッドを実行する権限について説明します。

(4)　引数

対象となるメソッドの引数に指定できる値とその意味について説明します。

(5)　戻り値

対象となるメソッドの実行後に戻される値とその意味を示します。

(6)　例外

対象となるメソッドで発生する例外について説明しています。発生する例外がないメソッドでは，「なし」と記述します。

(7)　注意事項

対象となるメソッドを使用するときに注意が必要な事柄について説明します。なお，引数の注意事項については，「1.4 各メソッドの引数の注意事項」を参照してください。

1.4　各メソッドの引数の注意事項

ここでは，JP1/AJS3 - SDKが提供する各メソッドの引数の注意事項について説明します。API利用時の注意事項については，マニュアル「JP1/Automatic Job Management System 3 - Softaware Development Kit 設計・構築ガイド」を参照してください。

1.4.1　バイト数の記載について

引数に記載されているバイト数は，要求先スケジューラーサービスの文字コードでのバイト数です。

ユニット名とコメントの場合は，要求先スケジューラーサービスで，文字コードにUTF-8を使用していて，環境設定パラメーター「DEFLENTYPE」が「sjis」のときに，文字コードシフトJISで換算したバイト数となります。

スケジューラーサービスの環境設定パラメーター「DEFLENTYPE」の詳細については，マニュアル「JP1/Automatic Job Management System 3 構築ガイド2」を参照してください。

1.4.2　指定する文字について

機種依存文字を使用しないでください。機種依存文字を使用した場合，文字化けするおそれがあります。

JP1/AJS3 - Managerで使用できる文字の範囲の詳細については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（システム構築編）」を参照してください。

1.4.3　メソッド共通の制限値

メソッド共通の制限値を次の表に示します。なお，メソッドの引数に，制限値を超えた値，または指定できない文字を指定した場合，JP1/AJS3 - SDKはAjsCdException例外クラスを取得します。

表1‒7　メソッド共通の制限値一覧

項目

制限値（バイト）

特記事項

引数に指定するJP1/AJS3 - Managerのホスト名

255

制御文字（改行文字やタブ文字など）は指定できません。

引数に指定するスケジューラーサービス名

30

引数に指定するジョブネット名（完全名）

930

制御文字（改行文字やタブ文字など），および次の文字は指定できません。

，（コンマ）

：（コロン）

；（セミコロン）

＝

(

)

半角スペース

引数に指定するジョブ名（完全名）

930

引数に指定するユニット名

30※

制御文字（改行文字やタブ文字など），および次の文字は指定できません。

，（コンマ）

：（コロン）

；（セミコロン）

/（スラント）

＝

(

)

半角スペース

引数に指定するユニットのコメント

80※

制御文字（改行文字やタブ文字など）は指定できません。

引数に指定するJP1ユーザー名

31

引数に指定する実行ホスト名

255

引数に指定するリリースID

30

制御文字（改行文字やタブ文字など），および次の文字は指定できません。

，（コンマ）

：（コロン）

；（セミコロン）

/（スラント）

＝

(

)

'（シングルクォーテーションマーク）

"（ダブルクォーテーションマーク）

’

‘

&

*

<

>

?

[

¥

]

^

{

|

}

~

半角スペース

戻り値として返却されるJP1資源グループ名

63

JP1/BaseのJP1資源グループ名の値が，英数字，および_（アンダーバー）を使用した文字列で返却されます。

戻り値として返却される実行エージェント名

255

JP1/AJS3の実行エージェント名の値が文字列で返却されます。

戻り値として返却される実行ID

10

JP1/AJS3の実行IDの値が「@［mmmm］｛A〜Z｝nnnn」の形式の文字列で返却されます。

注※

バイト数の換算については，「1.4.1 バイト数の記載について」を参照してください。

1.4.4　データ型クラスの引数チェックについて

データ型クラスに設定する値はsetterメソッド呼び出し時点では，長さや組み合わせの妥当性などのチェックはされません。AjsCdApiインターフェースのメソッドにデータ型クラスを指定してAPI要求した時点でチェックされます。

データ型クラスのgetterメソッド呼び出しの場合も，設定されている値の長さや組み合わせの妥当性などのチェックはされません。このため，仕様外のデータが設定されていても正常に取得され，例外は発生しません。

2　API処理クラス

API処理クラスのクラス，インターフェース，およびメソッドについて説明します。

2.1　AjsCdFactoryクラス

AjsCdインターフェースを実装したクラスインスタンスを生成，取得，破棄するためのクラスです。

クラス定義

public class AjsCdFactory

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

表2‒1　AjsCdFactoryクラスのメソッド一覧

メソッドの概要

public static AjsCdFactory

getInstance() throws AjsCdException

AjsCdFactoryクラスのインスタンスを取得します。

public AjsCd

createAjsCd(java.lang.String appName) throws AjsCdException

アプリケーションごとにJP1/AJS3 - SDKの初期化を行います。AjsCdインターフェースを実装したクラスインスタンスを生成します。

public AjsCd

getAjsCd(java.lang.String appName) throws AjsCdException

すでに生成されているAjsCdインターフェースを実装したクラスインスタンスを取得します。

public void

destroyAjsCd(java.lang.String appName) throws AjsCdException

アプリケーションごとにJP1/AJS3 - SDKの破棄を行います。AjsCdインターフェースを実装したクラスインスタンスを破棄します。

public void

destroyAjsCd(java.lang.String appName,

DestroyOption option) throws AjsCdException

アプリケーションごとにJP1/AJS3 - SDKの破棄を行います。AjsCdインターフェースを実装したクラスインスタンスを破棄します。（強制破棄する場合）

2.1.1　getInstanceメソッド

(1)　説明

AjsCdFactoryクラスのインスタンスを取得します。

(2)　形式

public static AjsCdFactory getInstance() throws AjsCdException

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

AjsCdFactoryクラスのインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.1.2　createAjsCdメソッド

(1)　説明

アプリケーションごとにJP1/AJS3 - SDKの初期化を行います。AjsCdインターフェースを実装したクラスインスタンスを生成します。

(2)　形式

public AjsCd createAjsCd(
　　　java.lang.String appName) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

appName

不可

アプリケーション名を1〜32バイトの文字列で指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

指定できる文字は半角英数字，および次の記号です。

! # $ % + −（ハイフン） _（アンダーバー）

大文字・小文字の区別はしません。

本引数で指定するアプリケーション名は，環境設定ファイルのアプリケーション名と一致させておく必要があります。

なお，指定するアプリケーション名はシステム（JVM）でユニークな値にしてください。

(5)　戻り値

AjsCdインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

すでに同じアプリケーション名を持つAjsCdクラスインスタンスが存在する場合，重複エラーになります。

2.1.3　getAjsCdメソッド

(1)　説明

すでに生成されているAjsCdインターフェースを実装したクラスインスタンスを取得します

(2)　形式

public AjsCd getAjsCd(
　　　java.lang.String appName) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

appName

不可

アプリケーション名を1〜32バイトの文字列で指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

指定できる文字は半角英数字，および次の記号です。

! # $ % + −（ハイフン） _（アンダーバー）

大文字・小文字の区別はしません。

本引数で指定するアプリケーション名は，環境設定ファイルのアプリケーション名と一致させておく必要があります。

(5)　戻り値

AjsCdインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

指定したアプリケーション名のAjsCdクラスインスタンスが存在しない場合，エラーとなります。

2.1.4　destroyAjsCdメソッド

(1)　説明

アプリケーションごとにJP1/AJS3 - SDKの破棄を行います。AjsCdインターフェースを実装したクラスインスタンスを破棄します。

このインスタンスがすでに破棄されている場合は，ログにメッセージを出力して処理を中断します。この場合，例外は発生しません。

なお，本メソッドは，destroyAjsCdApiメソッドですべてのAjsCdApiインスタンスを破棄したあとに呼び出してください。

(2)　形式

public void destroyAjsCd(
　　java.lang.String appName) throws AjsCdException

強制破棄する場合

public void destroyAjsCd(
　　java.lang.String appName,
　　DestroyOption option) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

appName

不可

アプリケーション名を1〜32バイトの文字列で指定してください。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

指定できる文字は半角英数字，および次の記号です。

! # $ % + −（ハイフン） _（アンダーバー）

大文字・小文字の区別はしません。

本引数で指定するアプリケーション名は，環境設定ファイルのアプリケーション名と一致させておく必要があります。

option

可

通常は本オプションは省略します。本オプションを省略した場合，実行中のAPIが終了したあと，AjsCdインターフェースを実装したクラスインスタンスを破棄します。

緊急時にAPI処理中にかかわらず強制的にAjsCdインターフェースを終了したい場合にだけ，「強制破棄」を指定してください。

「強制破棄」を指定した場合，処理中のAPIはすべて強制的に破棄されます。このため，APIの戻り値は保証されません。また，処理中のAPIでKNAK1501-Eのメッセージを出力するエラーが発生するおそれがあります。APIの処理がどこまで反映されているかを確認してください。

指定できる値と内容については，「付録A.1 (11)DestroyOption」を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.2　AjsCdインターフェース

AjsCdApiインターフェースを実装したクラスインスタンスを生成，取得，破棄するためのインターフェースです。

クラス定義

public interface AjsCd

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

表2‒2　AjsCdインターフェースのメソッド一覧

メソッドの概要

public AjsCdApi

createAjsCdApi(java.lang.String id) throws AjsCdException

AjsCdApiインターフェースを実装したクラスインスタンスを生成します。

public AjsCdApi

getAjsCdApi(java.lang.String id) throws AjsCdException

AjsCdApiインターフェースを実装したクラスインスタンスを取得します。

public void

destroyAjsCdApi(java.lang.String id) throws AjsCdException

AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。

public void

destroyAjsCdApi(java.lang.String id,

DestroyOption option) throws AjsCdException

AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。（強制破棄する場合）

2.2.1　createAjsCdApiメソッド

(1)　説明

AjsCdApiインターフェースを実装したクラスインスタンスを生成します。

(2)　形式

public AjsCdApi createAjsCdApi(
　　java.lang.String id) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

id

不可

AjsCdApiインターフェースを実装したクラスインスタンスを識別するための文字列（識別子）を1〜2,048バイトで指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

AjsCdインターフェースを実装したインスタンス内でユニークな値を指定してください。

なお，ここで指定した識別子は公開トレースログや内部ログに出力されます。

大文字・小文字を区別します。

(5)　戻り値

AjsCdApiインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

すでに同じ識別子を持つAjsCdApiクラスインスタンスが存在する場合，重複エラーになります。

2.2.2　getAjsCdApiメソッド

(1)　説明

AjsCdApiインターフェースを実装したクラスインスタンスを取得します。

(2)　形式

public AjsCdApi getAjsCdApi(
　　java.lang.String id) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

id

不可

AjsCdApiインターフェースを実装したクラスインスタンスを識別するための文字列（識別子）を1〜2,048バイトで指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

AjsCdインターフェースを実装したインスタンス内でユニークな値を指定してください。

なお，ここで指定した識別子は公開トレースログや内部ログに出力されます。

(5)　戻り値

AjsCdApiインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

指定した識別子のAjsCdApiクラスインスタンスが存在しない場合，エラーとなります。

2.2.3　destroyAjsCdApiメソッド

(1)　説明

AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。

このインスタンスがすでに破棄されている場合は，ログにメッセージを出力して処理を中断します。この場合，例外は発生しません。

なお，本メソッドは，logoutメソッドまたはlogoutAllメソッドで，ログインしているすべてのJP1/AJS3 - Managerからログアウトしたあとに呼び出してください。

(2)　形式

public void destroyAjsCdApi(
　　java.lang.String id) throws AjsCdException

強制破棄する場合

public void destroyAjsCdApi(
　　java.lang.String id,
　　DestroyOption option) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

id

不可

AjsCdApiインターフェースを実装したクラスインスタンスを識別するための文字列（識別子）を1〜2048バイトで指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

AjsCdインターフェースを実装したインスタンス内でユニークな値を指定してください。

なお，ここで指定した識別子は公開トレースログや内部ログに出力されます。

option

可

通常は本オプションは省略します。本オプションを省略した場合，実行中のAPIが終了したあと，AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。

緊急時にAPI処理中にかかわらず強制的にAjsCdApiインターフェースを終了したい場合にだけ，「強制破棄」を指定してください。

「強制破棄」を指定した場合，処理中のAPIはすべて強制的に破棄されます。このため，APIの戻り値は保証されません。また，処理中のAPIでKNAK1501-Eのメッセージを出力するエラーが発生するおそれがあります。APIの処理がどこまで反映されているかを確認してください。

指定できる値と内容については，「付録A.1 (11)DestroyOption」を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3　AjsCdApiインターフェース

JP1/AJS3 - Managerを操作するためのAPIのインターフェースです。

クラス定義

public interface AjsCdApi

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

表2‒3　AjsCdApiインターフェースのメソッド一覧

メソッドの概要

public void

login(java.lang.String manager,

java.lang.String userName,

java.lang.String passwd) throws AjsCdException

指定されたJP1ユーザーとパスワードで指定されたログイン対象のJP1/AJS3 - Managerに接続し，JP1/Base認証サーバでログイン認証を行います。

public void

logout(java.lang.String manager) throws AjsCdException

ログインしているJP1/AJS3 - Managerからログアウトします。

public void

logoutAll() throws AjsCdException

ログインしているすべてのJP1/AJS3 - Managerからログアウトします。

public java.lang.String

registerImmediateExec(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

AjsCdStartCondition startCondition,

AjsCdMacroVariableList macro) throws AjsCdException

指定されたジョブネットを即時実行登録します。

public void

registerPlannedExec(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

PlannedTimePassedType passedDaemonStarts,

PlannedTimePassedType passedRegForExe,

AjsCdMacroVariableList macro) throws AjsCdException

指定されたジョブネットを計画実行登録します。

public void

registerFixedExec(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String fixedScheduleFrom,

java.lang.String fixedScheduleTo,

int futureGeneration,

PlannedTimePassedType passedDaemonStarts,

AjsCdMacroVariableList macro) throws AjsCdException

指定されたジョブネットを確定実行登録します。

public void

cancelRegistration(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName) throws AjsCdException

指定された実行登録中のジョブネットの登録を解除します。

public java.lang.String

addExecSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String startTime,

AjsCdMacroVariableList macro) throws AjsCdException

指定されたジョブネットに実行予定を追加します。（ルートジョブネットを指定する場合）

public void

addExecSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

java.lang.String startTime) throws AjsCdException

指定されたジョブネットに実行予定を追加します。（ネストジョブネットを指定する場合）

public void

changeStartTime(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

ChangeStartTimeType kindTime,

java.lang.String time,

ChangePushedAheadType pushedAhead,

ChangeLowerType changeLower) throws AjsCdException

指定された実行登録済みのジョブネットの実行開始予定日時を一時的に変更します。

public void

execImmediate(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

ChangePushedAheadType pushedAhead,

ChangeLowerType changeLower) throws AjsCdException

指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，即時実行します。

public void

cancelExecSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，実行を中止します。

public void

restoreStartTime(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

指定されたジョブネットの実行開始予定日時の変更を解除します。

public void

changeHold(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

ChangeHoldAttr holdAttr) throws AjsCdException

指定されたジョブネットの保留属性を変更します。

public void

changeDelayMonitor(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

DelayMonitorType delayedStart,

java.lang.String delayedStartTime,

DelayMonitorType delayedEnd,

java.lang.String delayedEndTime,

java.lang.String monitoringJobnet

) throws AjsCdException

指定された登録済みのジョブネットの遅延監視の設定を一時的に変更できます。

public void

changeStatus(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

ChangeStatus newStatus,

int newReturnCode) throws AjsCdException

指定されたジョブの状態を変更できます。（終了コードを変更する場合）

public void

changeStatus(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

ChangeStatus newStatus) throws AjsCdException

指定されたジョブの状態を変更できます。（終了コードを変更しない場合）

public void

interrupt(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

指定された実行中のジョブネットを中断できます。

public void

kill(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

指定された実行中のジョブおよびジョブネットを強制終了できます。

public void

rerun(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

RootRerunType rerunMethod,

EnumSet<RerunOption> rerunOptions

) throws AjsCdException

実行が終了したジョブネットやジョブの実行結果を指定して，再実行できます。（ルートジョブネットの場合）

public void

rerun(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

RerunType rerunMethod,

EnumSet<RerunOption> rerunOptions

) throws AjsCdException

実行が終了したジョブネットやジョブの実行結果を指定して，再実行できます。（ネストジョブネットの場合）

public AjsCdSearchResult

searchUnit(java.lang.String manager,

java.lang.String serviceName,

AjsCdSearchCondition searchCondition

) throws AjsCdException

ユニットの一覧を取得します。（要求IDを設定しない場合）

public AjsCdSearchResult

searchUnit(java.lang.String manager,

java.lang.String serviceName,

java.lang.String id,

AjsCdSearchCondition searchCondition

) throws AjsCdException

ユニットの一覧を取得します。（要求IDを設定する場合）

public boolean

cancelSearch(java.lang.String manager,

java.lang.String serviceName) throws AjsCdException

実行中のsearchUnitメソッドでのユニット一覧取得を中止します。（要求IDを設定しないキャンセルの場合）

public boolean

cancelSearch(java.lang.String manager,

java.lang.String serviceName,

java.lang.String id) throws AjsCdException

実行中のsearchUnitメソッドでのユニット一覧取得を中止します。（要求IDを設定するキャンセルの場合）

public AjsCdUnitStatus

getUnitStatus(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

ユニットの実行状態および実行結果の詳細情報を取得します。

public java.lang.String

getExecResultDetails(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

実行が終了したジョブの実行結果詳細を取得します。

public java.util.List<AjsCdMacroVariable>

getInheritResult(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID) throws AjsCdException

指定されたジョブネットの実行登録時に指定したマクロ変数名と引き継ぎ情報，またはジョブ実行時に引き継いだマクロ変数名と引き継ぎ結果情報を取得します。

public AjsCdGetCurrentStatusesUnderJobGroupResult

getCurrentStatusesUnderJobGroup(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

AjsCdGetCurrentStatusesUnderJobGroupOption option

) throws AjsCdException

ジョブグループ直下のユニットのユニット定義情報，最新状態情報，および最新結果情報を取得します。

public AjsCdGetDefinitionsUnderJobnetResult

getDefinitionsUnderJobnet(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

java.lang.String releaseID

) throws AjsCdException

ジョブネット直下のユニット状態情報を取得します。

public AjsCdGetStatusesUnderJobnetResult

getStatusesUnderJobnet(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

AjsCdGetStatusesUnderJobnetOption option

) throws AjsCdException

ジョブネット直下のユニット状態情報を取得します。

public AjsCdGetRelationsUnderJobnetResult

getRelationsUnderJobnet(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String execID,

java.lang.String releaseID

) throws AjsCdException

ジョブネット直下の関連線情報を取得します。

public AjsCdGetScheduleResult

getSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

long begin,

long end,

DateType dateType,

java.lang.String releaseID,

AjsCdGetScheduleOption option

) throws AjsCdException

ジョブネットの予実績情報を取得します。（要求IDを設定しない場合）

public AjsCdGetScheduleResult

getSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

long begin,

long end,

DateType dateType,

java.lang.String releaseID,

java.lang.String id,

AjsCdGetScheduleOption option

) throws AjsCdException

ジョブネットの予実績情報を取得します。（要求IDを設定する場合）

public boolean

cancelGetSchedule(java.lang.String manager,

java.lang.String serviceName

) throws AjsCdException

実行中のgetScheduleメソッドでの予実績情報取得を中止します。（要求IDを設定しないキャンセルの場合）

public boolean

cancelGetSchedule(java.lang.String manager,

java.lang.String serviceName,

java.lang.String id

) throws AjsCdException

実行中のgetScheduleメソッドでの予実績情報取得を中止します。（要求IDを設定するキャンセル場合）

public AjsCdCalendar

getCalendar(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

java.lang.String month

) throws AjsCdException

カレンダー情報を取得します。（年月を指定して情報を取得する場合）

public AjsCdCalendar

getCalendar(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName

java.lang.String begin,

java.lang.String end) throws AjsCdException

カレンダー情報を取得します。（期間を指定して情報を取得する場合）

public AjsCdTotalSummary

getJobnetSummary(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName,

long begin,

long end,

AjsCdGetSummaryOption option

) throws AjsCdException

サマリー情報を取得します。

public java.util.List<AjsCdJobnetReleaseInfo>

getJobnetReleaseInfo(java.lang.String manager,

java.lang.String serviceName,

java.lang.String unitName

) throws AjsCdException

ルートジョブネットに設定されているリリース情報を取得します。

public java.util.List<AjsCdSchServiceDef>

enumSchService(java.lang.String manager

) throws AjsCdException

スケジューラーサービスの一覧を取得します。

public AjsCdSchServiceInfo

getSchServiceInfo(java.lang.String manager,

java.lang.String serviceName) throws AjsCdException

スケジューラーサービスの情報（文字コード，DB種別などに指定できる文字数の変更設定）を取得します。

public AjsCdAJSManager

getAJSManagerInfo(java.lang.String manager,

) throws AjsCdException

JP1/AJS3 - Managerの情報（バージョン，OS情報，データベース構成）を取得します。

public java.lang.String

getCharCode(java.lang.String manager,

java.lang.String serviceName) throws AjsCdException

APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを取得します。

public void

setCharCode(java.lang.String manager,

java.lang.String serviceName,

java.lang.String charCode) throws AjsCdException

APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを設定します。

2.3.1　loginメソッド

(1)　説明

指定されたJP1ユーザーとパスワードで指定されたログイン対象のJP1/AJS3 - Managerに接続し，JP1/Base認証サーバでログイン認証を行います。以降のメソッドについても，対象ホストに対する操作を行うためには，必ずログインが必要です。

JP1/AJS3 - Managerのログインの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」を参照してください。

(2)　形式

public void login(
　　java.lang.String manager,
　　java.lang.String userName,
　　java.lang.String passwd) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

ログインするJP1/AJS3 - Managerの物理ホスト名または論理ホスト名を，1〜255バイトの文字列で指定します。

userName

不可

ログインするJP1ユーザー名を，1〜31バイトの文字列で指定します。

ログインするJP1ユーザー名は，あらかじめログイン先のJP1/AJS3 - Managerホストが参照する認証サーバに登録されている必要があります。

JP1ユーザー名に指定できる文字の詳細については，マニュアル「JP1/Base 運用ガイド」のユーザー管理の設定について記載している個所を参照してください。

passwd

不可

ログインするユーザーのパスワードを指定します。

パスワードに指定できる文字の詳細については，マニュアル「JP1/Base 運用ガイド」のユーザー管理の設定について記載している個所を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.2　logoutメソッド

(1)　説明

ログインしているJP1/AJS3 - Managerからログアウトします。

ログインしたJP1/AJS3 - Managerからは必ずログアウトしてください。ログアウトを行わなかった場合，JP1/AJS3 - Managerとの接続情報，および認証情報が解放されません。

接続先からのログアウトに失敗した場合は，ログにメッセージを出力して処理を中断します。この場合，例外は発生しません（引数不正の場合は例外が発生します）。

なお，本メソッドは，ログインしているJP1/AJS3 - ManagerへのAPI処理がすべて完了したあとに呼び出してください。

JP1/AJS3 - Managerからのログアウトの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」を参照してください。

(2)　形式

public void logout(
　　java.lang.String manager) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

ログアウト対象のJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.3　logoutAllメソッド

(1)　説明

ログインしているすべてのJP1/AJS3 - Managerからログアウトします。

接続先からのログアウトに失敗した場合は，ログにメッセージを出力して（例外は発生しません），ほかの接続先とのログアウト処理を行います。

なお，本メソッドは，ログインしているJP1/AJS3 - ManagerへのAPI処理がすべて完了したあとに呼び出してください。

JP1/AJS3 - Managerからのログアウトの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」を参照してください。

(2)　形式

public void logoutAll() throws AjsCdException

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.4　registerImmediateExecメソッド

(1)　説明

指定されたジョブネットを即時実行登録します。

取得した実行IDは，即時実行登録したジョブネットに対する強制終了API（「2.3.17 killメソッド」）や，実行状態や実行結果の詳細情報取得API（「2.3.21 getUnitStatusメソッド」）などで使用できます。

即時実行登録できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行登録について記載している個所を参照してください。

(2)　形式

public java.lang.String registerImmediateExec(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　AjsCdStartCondition startCondition,
　　AjsCdMacroVariableList macro) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

startCondition

可

起動条件を使ってジョブネットを実行する場合，起動条件クラスを指定します。

起動条件を使用しない場合は，nullを指定してください。

設定の詳細については，「3.4 起動条件クラス（AjsCdStartCondition）」を参照してください。なお，オペレーションネットの場合は起動条件を指定できないため，nullを指定してください。起動条件が指定されている場合は，引数エラーとして例外を発生させます。

macro

可

ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数リストクラスで指定します。

設定の詳細については，「3.5 マクロ変数リストクラス（AjsCdMacroVariableList）」を参照してください。

マクロ変数を引き継がない場合は「null」を指定してください。

(5)　戻り値

実行IDを「@［mmmm］｛A〜Z｝nnnn」の形式で返却します。起動条件を指定している場合は監視世代の実行IDを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.5　registerPlannedExecメソッド

(1)　説明

指定されたジョブネットを計画実行登録します。

計画実行登録できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行登録について記載している個所を参照してください。

(2)　形式

public void registerPlannedExec(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　PlannedTimePassedType passedDaemonStarts,
　　PlannedTimePassedType passedRegForExe,
　　AjsCdMacroVariableList macro) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

passedDaemonStar

ts

不可

デーモン起動時に予定時刻を超過していた場合の動作を定数で指定します。

指定できる値と内容については，「付録A.1 (1)PlannedTimePassedType」を参照してください。

この項目は，サービス起動モードが［ウォーム］（warm）の場合に有効です。その他の場合は無視されます。

passedRegForExe

不可

実行登録時に予定時刻を超過していた場合の動作を定数で指定します。

指定できる値と内容については，「付録A.1 (1)PlannedTimePassedType」を参照してください。

macro

可

ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数リストクラスで指定します。

設定の詳細については，「3.5 マクロ変数リストクラス（AjsCdMacroVariableList）」を参照してください。

マクロ変数を引き継がない場合は「null」を指定してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.6　registerFixedExecメソッド

(1)　説明

指定されたジョブネットを確定実行登録します。

確定実行登録できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行登録について記載している個所を参照してください。

(2)　形式

public void registerFixedExec(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String fixedScheduleFrom,
　　java.lang.String fixedScheduleTo,
　　int futureGeneration,
　　PlannedTimePassedType passedDaemonStarts,
　　AjsCdMacroVariableList macro) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

fixedScheduleFrom

可

確定実行スケジュールで実行する［確定期間］の開始年月日を，「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

指定する年月日は，要求先JP1/AJS3 - Managerが認識する年月日で指定してください。確定期間開始年月日を指定した場合，確定期間終了年月日は必ず指定してください。指定されていない場合，例外クラスが送出されます。

確定期間指定を行わない場合はnullを指定してください。

fixedScheduleTo

可

確定実行スケジュールで実行する［確定期間］の終了年月日を，「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

指定する年月日は，要求先JP1/AJS3 - Managerが認識する年月日で指定してください。確定期間終了年月日を指定した場合，確定期間開始年月日は必ず指定してください。指定されていない場合，例外クラスが送出されます。

確定期間指定を行わない場合はnullを指定してください。

futureGeneration

可

何回先まで実行予定を作成するかの［未来世代数］を，数値で指定します。指定できる値は，1〜99（単位：世代）です。

［確定期間］と［未来世代数］を同時に指定した場合，実行スケジュールは次のように定義されます。

［確定期間］で指定した確定実行スケジュールの実行予定回数が，［未来世代数］で指定した確定実行スケジュールの実行予定回数より多い場合（処理サイクル1日単位）

［確定期間］で指定した確定実行スケジュールの実行予定回数分だけ，確定実行登録されます。ジョブネット実行終了時に確定世代が未来世代数より少なくなると，確定世代が未来世代数になるように新たな世代が登録されます。

［確定期間］で指定した実行予定の回数が，［未来世代数］で指定した実行予定の回数より少ない場合（処理サイクル1日単位）

［未来世代数］で指定された確定実行スケジュールの実行予定回数分だけ，確定実行登録されます。ジョブネット実行終了時に確定世代が未来世代数より少なくなると，確定世代が未来世代数になるように新たな世代が登録されます。

確定未来世代数の指定を行わない場合は0を指定してください。

passedDaemonStarts

不可

デーモン起動時に予定時刻を超過していた場合の動作を定数で指定します。

指定できる値と内容は「付録A.1 (1)PlannedTimePassedType」を参照してください。

この項目は，サービス起動モードが［ウォーム］（warm）の場合に有効です。その他の場合は無視されます。

macro

可

ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数リストクラスで指定します。

設定の詳細については，「3.5 マクロ変数リストクラス（AjsCdMacroVariableList）」を参照してください。

マクロ変数を引き継がない場合は「null」を指定してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.7　cancelRegistrationメソッド

(1)　説明

指定された実行登録中のジョブネットの登録を解除します。

登録を解除できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの登録の解除について記載している個所を参照してください。

(2)　形式

public void cancelRegistration(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.8　addExecScheduleメソッド

(1)　説明

指定されたジョブネットに実行予定を追加します。

実行予定を追加できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行予定の追加について記載している個所を参照してください。

(2)　形式

ルートジョブネットを指定する場合

public java.lang.String addExecSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String startTime,
　　AjsCdMacroVariableList macro) throws AjsCdException

ネストジョブネットを指定する場合

public void addExecSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　java.lang.String startTime) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

ネストジョブネットの場合は実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

startTime

不可

確定実行スケジュールの開始日時を，「YYYYMMDDhhmm」形式の文字列で指定します（12文字固定）。

指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。

mm：分を指定します。分に指定できる値は00〜59（単位：分）です。

指定する日時は，要求先JP1/AJS3 - Managerが認識する日時で指定してください。

macro

可

ルートジョブネットの場合は，ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数リストクラスで指定します。

設定の詳細については，「3.5 マクロ変数リストクラス（AjsCdMacroVariableList）」を参照してください。

マクロ変数を引き継がない場合は，型を明記して「null」を指定してください。

(5)　戻り値

ルートジョブネットの場合，実行IDを「@［mmmm］｛A〜Z｝nnnn」の形式で返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.9　changeStartTimeメソッド

(1)　説明

指定された実行登録済みのジョブネットの実行開始予定日時を一時的に変更します（変更した内容で実行したあとは，ジョブネットに定義されたスケジュールに従って実行します）。

実行開始予定日時を一時的に変更できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行日時の一時変更について記載している個所を参照してください。

(2)　形式

public void changeStartTime(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　ChangeStartTimeType kindTime,
　　java.lang.String time,
　　ChangePushedAheadType pushedAhead,
　　ChangeLowerType changeLower) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

kindTime

不可

一時的に変更する実行予定の実行開始日時を，開始日時または相対日時のどちらで指定するかを定数で指定します。

指定できる値と内容については，「付録A.1 (2)ChangeStartTimeType」を参照してください。

time

不可

kindTimeに「ABSOLUTETIME（開始日時を指定する）」を指定した場合は，一時的に変更する実行予定の実行開始日時を，「YYYYMMDDhhmm」形式の文字列で指定します（12文字固定）。

指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

hh：時間を指定します。時間に指定できる値は00〜47(単位：時)です。

mm：分を指定します。分に指定できる値は00〜59（単位：分）です。

指定する日時は，要求先JP1/AJS3 - Managerが認識する日時で指定してください。

kindTimeに「RELATIVETIME（相対日時を指定する）」を指定した場合は，一時的に変更する実行開始日を，一時変更の操作対象となる世代の実行予定日からの相対日時で，「{+|-} DDhhmm」形式の文字列で指定します（7文字固定）。

指定できる値を次に示します。

+：実行開始日時を変更前の実行開始日時より後ろに変更します。

-：実行開始日時を変更前の実行開始日時より前に変更します。

DD：日を指定します。指定できる値は，00〜99（単位：日）です。

hh：時間を指定します。指定できる値は，00〜47（単位；時）です。

mm：分を指定します。指定できる値は，00〜59（単位：分）です。

ただし{+|-}000000は指定できません。

pushedAhead

可

ルートジョブネットの場合で，開始時間を前倒しに変更する場合に，変更前の開始時間に実行予定を追加するかどうかを定数で指定します。

指定できる値と内容については「付録A.1 (3)ChangePushedAheadType」を参照してください。

ルートジョブネット以外では本指定は無視されます。

changeLower

不可

配下の開始日時をずらすかどうかを定数で指定します。

「SHIFT（配下の開始日時もずらす）」を指定した場合，選択したジョブネットの下にあるすべてのジョブネットの開始時間を相対的に変更できます。

「NOTSHIFT（配下の開始日時はずらさない）」を指定した場合，選択したジョブネットだけ，開始時間を変更します。指定できる値と内容については，「付録A.1 (4)ChangeLowerType」を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.10　execImmediateメソッド

(1)　説明

指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，即時実行します（変更した内容で実行したあとは，ジョブネットに定義されたスケジュールに従って実行します）。

一時的に即時実行できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の登録済みのジョブネットの即時実行について記載している個所を参照してください。

(2)　形式

public void execImmediate(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　ChangePushedAheadType pushedAhead,
　　ChangeLowerType changeLower) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

pushedAhead

可

ルートジョブネットの場合で，開始時間を前倒しに変更する場合に，変更前の開始時間に実行予定を追加するかどうかを定数で指定します。

指定できる値と内容については，「付録A.1 (3)ChangePushedAheadType」を参照してください。

ルートジョブネット以外では本指定は無視されます。

changeLower

不可

配下の開始日時をずらすかどうかを定数で指定します。

「SHIFT（配下の開始日時もずらす）」を指定した場合，選択したジョブネットの下にあるすべてのジョブネットの開始時間を相対的に変更できます。

「NOTSHIFT（配下の開始日時はずらさない）」を指定した場合，選択したジョブネットだけ，開始時間を変更します。

指定できる値と内容については，「付録A.1 (4)ChangeLowerType」を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.11　cancelExecScheduleメソッド

(1)　説明

指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，実行を中止します（変更した内容で実行したあとは，ジョブネットに定義されたスケジュールに従って実行します）。

一時的に実行を中止できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットやジョブの実行の中止について記載している個所を参照してください。

(2)　形式

public void cancelExecSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.12　restoreStartTimeメソッド

(1)　説明

指定されたジョブネットの実行開始予定日時の変更を解除します。

一時変更した実行開始日時の変更，および実行中止を解除し，変更前の情報に戻します。一時変更を複数実行した場合，最初の変更の前の情報に戻されます。

実行開始予定日時の変更を解除できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行日時の一時変更について記載している個所を参照してください。

(2)　形式

public void restoreStartTime(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.13　changeHoldメソッド

(1)　説明

指定されたジョブネットの保留属性を変更します。

保留属性を変更できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットやジョブの保留属性の一時変更について記載している個所を参照してください。

(2)　形式

public void changeHold(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　ChangeHoldAttr holdAttr) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

holdAttr

不可

保留属性設定か保留属性設定解除かを定数で指定します。

指定できる値と内容については，「付録A.1 (5)ChangeHoldAttr」を参照してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.14　changeDelayMonitorメソッド

(1)　説明

指定された登録済みのジョブネットの遅延監視の設定を一時的に変更できます。

遅延監視の設定を一時的に変更できるジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの遅延監視設定の一時変更について記載している個所を参照してください。

(2)　形式

public void changeDelayMonitor(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　DelayMonitorType delayedStart,
　　java.lang.String delayedStartTime,
　　DelayMonitorType delayedEnd,
　　java.lang.String delayedEndTime,
　　java.lang.String monitoringJobnet) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

delayedStart

不可

開始遅延監視する方法を定数で指定します。

指定できる値と内容については，「付録A.1 (6)DelayMonitorType」を参照してください。

ルートジョブネットに対して，指定できない定数を指定した場合は引数エラーとして例外を発生させます。

ジョブネットが実行中の場合，本指定は無視されます。

delayedStartTime

可

「delayedStart」に「NOT（監視しない）」以外を指定した場合に，開始遅延の監視を始める時刻を文字列で指定します。なお，「NOT（監視しない）」を指定した場合は，nullを指定してください（値は無視します）。

「ABSOLUTE（絶対時刻）」を指定した場合

「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。

指定する時刻は，要求先JP1/AJS3 - Managerが認識する時刻で指定してください。

「ROOT（相対時刻）」/「TOP（相対時刻）」/「OWN（相対時刻）」を指定した場合

相対時刻を「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。ただし，0000は指定できません（1分〜47時間59分）。

ジョブネットが実行中の場合，本指定は無視されます。

delayedEnd

不可

終了遅延監視する方法を定数で指定します。

指定できる値と内容については，「付録A.1 (6)DelayMonitorType」を参照してください。

ルートジョブネットに対して，指定できない定数を指定した場合は引数エラーとして例外を発生させます。

delayedEndTime

可

「delayedEnd」に「NOT（監視しない）」以外を指定した場合に，終了遅延の監視を始める時刻を文字列で指定します。なお，「NOT（監視しない）」を指定した場合は，nullを指定してください（値は無視します）。

「ABSOLUTE（絶対時刻）」を指定した場合

「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。

指定する時刻は，要求先JP1/AJS3 - Managerが認識する時刻で指定してください。

「ROOT（相対時刻）」/「TOP（相対時刻）」/「OWN（相対時刻）」を指定した場合

相対時刻を「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。ただし，0000は指定できません（1分〜47時間59分）。

monitoringJobnet

可

ジョブネットの実行所要時間による終了遅延監視をする場合に，ジョブネットの実行所要時間を指定します。

「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。mmに指定できる値は，00〜59（単位：分）です。ただし，0000は指定できません（1分〜47時間59分）。

ジョブネットの実行所要時間による終了遅延監視を行わない場合は，nullを指定してください。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.15　changeStatusメソッド

(1)　説明

指定されたジョブの状態を変更できます。

状態を変更できるジョブの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブの状態の変更について記載している個所を参照してください。

(2)　形式

終了コードを変更する場合

public void changeStatus(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　ChangeStatus newStatus,
　　int newReturnCode) throws AjsCdException

終了コードを変更しない場合

public void changeStatus(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　ChangeStatus newStatus) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

newStatus

不可

変更後の状態を定数で指定します。

指定できる値と内容については，「付録A.1 (10)ChangeStatus」を参照してください。

ホストリンクジョブネットの場合，「NORMAL（正常終了にする）」以外を指定すると例外を発生します。

ジョブネットコネクタの場合，「NOT（変更しない）」，「FAIL（起動失敗にする）」，「BYPASS（計画未実行にする）」，および「RETURNCODE（終了コードで判定する）」を指定すると例外を発生します。

ユニットがイベントジョブ，アクションジョブまたはORジョブの場合，「RETURNCODE（終了コードで判定する）」は指定できません。

イベントジョブ，アクションジョブまたはORジョブの場合，「RETURNCODE（終了コードで判定する）」を指定すると例外を発生します。

選択したユニットが判定ジョブの場合，状態を変更できません。判定ジョブの場合，「NOT（変更しない）」以外を指定すると例外を発生します。

newReturnCode

可

変更後の終了コードを指定します。指定を省略した場合は，終了コードを変更しません。

指定できる値は，-2,147,483,648〜2,147,483,647です。

ホストリンクジョブネット，またはジョブネットコネクタの場合，終了コードを指定すると例外を発生します。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.16　interruptメソッド

(1)　説明

指定された実行中のルートジョブネットを中断できます。

中断できる実行中のルートジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の実行中のジョブネットの中断について記載している個所を参照してください。

(2)　形式

public void interrupt(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.17　killメソッド

(1)　説明

指定された実行中のジョブおよびジョブネットを強制終了できます。

強制終了できる実行中のジョブおよびルートジョブネットの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の実行中のジョブネットやジョブの強制終了について記載している個所を参照してください。

(a)　強制終了できるユニットの状態

次の状態のジョブまたはルートジョブネットだけを強制終了できます。

ジョブの場合

キューイング

実行中

キューレスジョブの場合は，「実行待ち」状態のジョブも強制終了できます。

ルートネットジョブの場合

実行中

警告検出中

異常検出実行中

監視中

(2)　形式

public void kill(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.18　rerunメソッド

(1)　説明

実行が終了したジョブネットやジョブの実行結果を指定して，再実行できます。

再実行できる実行が終了したジョブネットおよびジョブの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の実行が終了したジョブネットやジョブの再実行について記載している個所を参照してください。

(2)　形式

ルートジョブネットの場合

public void rerun(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　RootRerunType rerunMethod,
　　EnumSet<RerunOption> rerunOptions) throws AjsCdException

ネストジョブネット，またはジョブの場合

public void rerun(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID,
　　RerunType rerunMethod,
　　EnumSet<RerunOption> rerunOptions) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Operator権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

要求対象のジョブネット（ユニット）の完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

rerunMethod

不可

再実行方法を定数で指定します。

指定できる値と内容はルートジョブネットの場合は「付録A.1 (7)RootRerunType」，ネストジョブネットまたはジョブの場合は「付録A.1 (8)RerunType」を参照してください。

ユニット種別にあった指定がされなかった場合は引数エラーとして例外を発生させます。

rerunOptions

不可

再実行するユニットを保留状態にするか，異常状態の先行ユニットを警告終了にするかを定数で指定します。

指定は「付録A.1 (9)RerunOption」の組み合わせをEnumSetで指定します。どちらも指定しない場合は，空のenumセットを指定してください。

「rerunMethod」と同時に指定できない組み合わせ，またはユニット種別にあった指定がされなかった場合は引数エラーとして例外を発生させます。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.19　searchUnitメソッド

(1)　説明

ユニット一覧を取得します。

指定されたユニット，またはユニット配下の，ジョブグループ，ジョブネットまたはジョブの情報を取得します。取得するユニットは，検索条件を指定して取得します。条件を複数指定した場合，条件をすべて満たすユニットの一覧が取得されます。ログインしたJP1ユーザーに参照権限がないユニットの情報は取得できません。

取得できるユニットの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のユニットの検索について記載している個所を参照してください。

(2)　形式

要求IDを設定しない場合

public AjsCdSearchResult searchUnit(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　AjsCdSearchCondition searchCondition) throws AjsCdException

要求IDを設定する場合（キャンセルで要求を区別する場合）

public AjsCdSearchResult searchUnit(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String id,
　　AjsCdSearchCondition searchCondition) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

id

可

APIの要求を識別するための文字列（要求ID）を1〜2,048バイトで指定します。バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

要求IDは，cancelSearchメソッドでキャンセルする処理を特定したい場合に指定します。

要求IDを指定した場合， cancelSearchメソッドの引数に同じ要求IDを指定することで，本メソッドの処理だけをキャンセルすることができます。

要求IDを省略した場合，cancelSearchメソッドの引数に要求IDを指定しないことで，本メソッドの処理をキャンセルすることができます。

キャンセルの詳細については，「2.3.20 cancelSearchメソッド」を参照してください。

searchCondition

不可

検索条件を指定した，ユニット検索条件クラスを指定します。

ユニット検索条件クラスの詳細については，「3.7 ユニット検索条件クラス（AjsCdSearchCondition）」を参照してください。

(5)　戻り値

取得したユニットの情報を，ユニット検索結果インターフェース（AjsCdSearchResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

cancelSearchメソッドによってキャンセルされた場合，例外クラス（AjsCdApiCancelException）を送出します。

2.3.20　cancelSearchメソッド

(1)　説明

キャンセルを要求します。

実行中のsearchUnitメソッドでのユニット一覧取得を中止します。

(2)　形式

要求IDを指定しないキャンセルの場合

public boolean cancelSearch(
　　java.lang.String manager,
　　java.lang.String serviceName) throws AjsCdException

要求IDの指定によるキャンセルの場合

public boolean cancelSearch(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String id) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

id

可

要求IDを指定してキャンセルする場合に指定します。

要求IDはsearchUnitメソッドで設定したものを指定します。

省略した場合は，searchUnitメソッドで要求IDを設定していない要求だけがキャンセルされます。

(5)　戻り値

キャンセル要求したかどうかをbooleanで返却します。

この値は，ユニット一覧取得をキャンセルできたかどうかではなく，ユニット一覧取得のキャンセル要求ができたかどうかを指します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

本APIはsearchUnitメソッドが対象となります。キャンセル対象の処理がない場合，戻り値には「false」を返却します。また，戻り値が「true」の場合でも，JP1/AJS3 - Managerのホストにキャンセル要求を送信したタイミングによっては（処理の開始前，処理の終了後など），キャンセルされないときがあります。

本APIとすれ違いでsearchUnitメソッドが開始した場合，処理はキャンセルされません（searchUnitメソッドは例外を送出しません）。処理をキャンセルするには，本APIを再発行してください。

実行中のsearchUnitメソッドをキャンセルできた場合でも，本APIは例外を送出せずに，正常終了します。なお，処理をキャンセルされたsearchUnitメソッドは例外を送出します。

本APIにより，実行中のsearchUnitメソッドに対して処理をキャンセルするのとほぼ同時にsearchUnitメソッドの処理が終了（cancelSearchメソッドは正常終了）するケースの場合，searchUnitメソッドによるJP1/AJS3 - Managerからのデータ取得が完了しているタイミング以降では，searchUnitメソッドはメソッド内の後処理を続行して，例外を送出することなく正常終了します。

本APIの実行は，searchUnitメソッドと別スレッドで実行してください。

2.3.21　getUnitStatusメソッド

(1)　説明

ユニットの実行状態および実行結果の詳細情報を取得します。

指定された実行登録済みのジョブネットやジョブの実行状態および実行結果の詳細情報を取得します。

実行状態および実行結果の詳細情報を取得できるユニットの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のJP1/AJS3 - Viewウィンドウのモニタ詳細について記載している個所を参照してください。

(2)　形式

public AjsCdUnitStatus getUnitStatus(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行ID を，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

ユニットの実行状態および実行結果の詳細情報を，ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.22　getExecResultDetailsメソッド

(1)　説明

実行が終了したジョブの，実行結果詳細を取得します。

実行結果詳細を取得できるジョブの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のJP1/AJS3 - Viewウィンドウの実行結果詳細について記載している個所を参照してください。

(2)　形式

public java.lang.String getExecResultDetails(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行ID を，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

実行結果詳細を文字列で返却します。

実好結果詳細が存在しない場合は，空文字列を返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.23　getInheritResultメソッド

(1)　説明

指定されたジョブネットの実行登録時に指定したマクロ変数名と引き継ぎ情報，またはジョブ実行時に引き継いだマクロ変数名と引き継ぎ結果情報を取得します。

取得できるマクロ変数名と引き継ぎ結果情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のマクロ変数を使用した業務の作成方法について記載している個所を参照してください。

(2)　形式

public java.util.List<AjsCdMacroVariable> getInheritResult(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String execID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

引き継ぎ結果をマクロ変数インターフェース（AjsCdMacroVariable）のインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。引き継ぎ結果がない場合は，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.24　getCurrentStatusesUnderJobGroupメソッド

(1)　説明

指定されたジョブグループ直下のユニット（ジョブグループ，ジョブネット，またはジョブ）のユニット定義情報，最新状態情報，および最新結果情報を取得します。

ログインしたJP1ユーザーが，指定したジョブグループ直下のユニットに参照権限がない場合でも情報は取得されます。

最新状態としてどの世代の実行状態が取得されるかは，要求を依頼するJP1/AJS3 - Managerの環境設定パラメーター「VIEWSTATUSRANGE」の設定値に従います。

詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の［JP1/AJS3 - View］ウィンドウでの監視のリストエリアについて記載している個所を参照してください。

取得できるジョブグループ直下のユニット（ジョブグループ，ジョブネット，またはジョブ）のユニット定義情報，最新状態情報，および最新結果情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のJP1/AJS3 - View で使用するウィンドウおよびダイアログボックスのカスタマイズで，メイン画面のリストエリアについて記載している個所を参照してください。

(2)　形式

public AjsCdGetCurrentStatusesUnderJobGroupResult getCurrentStatusesUnderJobGroup(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　AjsCdGetCurrentStatusesUnderJobGroupOption option) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。

ジョブグループ

プランニンググループ

なお，マネージャージョブグループは指定できません。

option

可

取得オプションを設定したジョブグループ直下ユニット取得オプションクラスを指定します。

ジョブグループ直下ユニット取得オプションクラスの詳細については，「3.9 ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）」を参照してください。

本引数を省略する場合はnullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。

(5)　戻り値

取得した結果を，ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

本メソッドは，取得対象のジョブネット数によって，JP1/AJS3 - Manager やネットワークに負荷がかかることがあります。また，対象ジョブネット数が増えるに従い，所要メモリ量と応答時間が増加します。

対象ジョブネット数が多い場合は，連続して使用しないなどを検討してください。

2.3.25　getDefinitionsUnderJobnetメソッド

(1)　説明

指定されたジョブネット直下のユニット（ジョブネットやジョブ）のユニット定義情報を取得します。

ログインしたJP1ユーザーが，指定したジョブネット直下のユニットに参照権限がない場合でも情報は取得されます。

取得できるジョブネット直下のユニット（ジョブネットやジョブ）のユニット定義情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブフローの作成方法について記載している個所を参照してください。

(2)　形式

public AjsCdGetDefinitionsUnderJobnetResult getDefinitionsUnderJobnet(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　java.lang.String execID,
　　java.lang.String releaseID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

ネストジョブネット

起動条件

なお，リモートジョブネット配下のネストジョブネットは指定できません。

execID※

可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A 〜 Z｝nnnn」です。

本引数は，ジョブネットリリース機能を使用している場合に，実行IDの世代に対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。

releaseID※

可

リリースIDを，1〜30バイトの文字列で指定します。

本引数は，ジョブネットリリース機能を使用している場合に，リリースIDに対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。

本指定は，接続先JP1/AJS3 - Managerが標準構成の場合にだけ有効です。それ以外の場合は本指定は無視されます（指定がなかった場合と同じ動作をします）。

注※

実行IDとリリースIDは同時に指定できません。同時に指定した場合は，例外を送出します。どちらも省略した場合は，本メソッドを呼び出した時点で適用されているユニット定義情報を取得します。

(5)　戻り値

取得したユニットの情報を，ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

本メソッドの引数に起動条件付きのルートジョブネットを指定すると，配下ユニットの一覧に起動条件が含まれます。また，この場合，起動条件ユニットの座標位置はX座標0，Y座標0が固定で設定されます。

位置情報と関連線を使用して図を描く場合の詳細については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のジョブの実行ステータスをジョブフロー形式で監視する画面の「マップ表示」について記載している個所を参照してください。

2.3.26　getStatusesUnderJobnetメソッド

(1)　説明

指定されたジョブネット直下のユニット（ジョブネットやジョブ）のユニット状態情報を取得します。

ログインしたJP1ユーザーが，指定したジョブネット直下のユニットに参照権限がない場合でも情報は取得されます。

取得できるジョブネット直下のユニット（ジョブネットやジョブ）のユニット状態情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブフローの作成方法について記載している個所を参照してください。

(2)　形式

public AjsCdGetStatusesUnderJobnetResult getStatusesUnderJobnet(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　java.lang.String execID,
　　AjsCdGetStatusesUnderJobnetOption option) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

ネストジョブネット

起動条件

なお，リモートジョブネット配下のネストジョブネットは指定できません。

execID

不可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A 〜 Z｝nnnn」です。

option

可

取得オプションを設定したジョブネット直下ユニット取得オプションクラスを指定します。

ジョブネット直下ユニット状態取得オプションクラスの詳細については，「3.14 ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）」を参照してください。

本引数を省略する場合は，nullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。

(5)　戻り値

取得したユニットの情報を，ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

このメソッドで取得した情報には，ユニット名などの定義情報は含まれません。定義情報はgetDefinitionsUnderJobnetメソッドやsearchUnitメソッドなどで取得し，ユニットIDをキーにして該当する定義を求めてください。

このメソッドで取得した情報には，サスペンド中に削除されたユニット情報も含まれます。

2.3.27　getRelationsUnderJobnetメソッド

(1)　説明

指定されたジョブネット直下のユニット（ジョブネットやジョブ）の関連線情報を取得します。

取得できるジョブネット直下のユニット（ジョブネットやジョブ）の関連線情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブフローの作成方法について記載している個所を参照してください。

(2)　形式

public AjsCdGetRelationsUnderJobnetResult getRelationsUnderJobnet(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　java.lang.String execID,
　　java.lang.String releaseID) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

ネストジョブネット

起動条件

なお，リモートジョブネット配下のネストジョブネットは指定できません。

execID※

可

実行IDを，文字列で指定します。

指定する形式は「@［mmmm］｛A 〜 Z｝nnnn」です。

本引数は，ジョブネットリリース機能を使用している場合に，実行IDの世代に対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。

releaseID※

可

リリースIDを，1〜30バイトの文字列で指定します。

本引数は，ジョブネットリリース機能を使用している場合に，リリースIDに対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。

本指定は，接続先JP1/AJS3 - Managerが標準構成の場合にだけ有効です。それ以外の場合は本指定は無視されます（指定がなかった場合と同じ動作をします）。

注※

実行IDとリリースIDは同時に指定できません。同時に指定した場合は，例外を送出します。どちらも省略した場合は，本メソッドを呼び出した時点で適用されているユニット定義情報を取得します。

(5)　戻り値

取得したユニットの情報を，ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

このメソッドで取得した情報には，ユニット名などの定義情報は含まれません。定義情報はgetDefinitionsUnderJobnetメソッドやsearchUnitメソッドなどで取得し，ユニットIDをキーにして該当する定義を求めてください。

2.3.28　getScheduleメソッド

(1)　説明

指定されたジョブネットの，ジョブネットやジョブの実行予実績や実行状態を取得します。実行予定は擬似予定も取得できます。

本メソッドはcancelGetScheduleメソッドでキャンセルすることができます。cancelGetScheduleメソッドでキャンセルする処理を特定したいときは，要求IDを指定して呼び出してください。

ログインしたJP1ユーザーに参照権限がないユニットが存在する場合は，すべてのユニットの情報を取得できません。参照権限がないユニットが存在した場合は，例外を送出します。

ジョブネットの，ジョブネットやジョブの実行予実績や実行状態の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の実行予定の確認について記載している個所，およびマニュアル「JP1/Automatic Job Management System 3 設計ガイド（業務設計編）」の2日にまたがる業務のスケジュールを立てる方法について記載している個所を参照してください。

(2)　形式

要求IDを設定しない場合

public AjsCdGetScheduleResult getSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　long begin,
　　long end,
　　DateType dateType,
　　java.lang.String releaseID,
　　AjsCdGetScheduleOption option) throws AjsCdException

要求IDを設定する場合（キャンセルで要求を区別する場合）

public AjsCdGetScheduleResult getSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　long begin,
　　long end,
　　DateType dateType,
　　java.lang.String releaseID,
　　java.lang.String id,
　　AjsCdGetScheduleOption option) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

ルートリモートジョブネット

begin※

不可

スケジュールを取得する期間の開始時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。

指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。

なお，本引数には引数endで指定した時間以前の値を指定してください。それ以外の値を指定した場合は，例外を送出します。

end※

不可

スケジュールを取得する期間の終了時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。

指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。

なお，本引数には引数beginで指定した時間以降の値を指定してください。それ以外の値を指定した場合は，例外を送出します。

dateType

不可

スケジュールを取得する期間の指定が暦日か実行日かを指定します。

指定できる値と内容については，「付録A.9 (2)DateType」を参照してください。

なお，「EXECUTION_DATE（実行日）」を指定した場合，引数begin（開始時間）と引数end（終了時間）で指定する期間は日単位（基準時刻からの1日）で扱われます。1日未満で基準時刻を含まない日のスケジュールは取得されませんので，取得対象日の基準時刻が含まれるように指定してください。

releaseID

可

リリースIDを，1〜30バイトの文字列で指定します。

本引数は，ジョブネットリリース機能を使用している場合に，リリースIDに対応したユニットの予実績情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。

本引数を指定した場合は，指定したリリースIDに対応したユニットの予実績情報を取得します。

本引数を省略した場合は，本メソッドを呼び出した時点で適用されているユニットの予実績情報を取得します。

本指定は，接続先JP1/AJS3 - Managerが標準構成の場合にだけ有効です。それ以外の場合は本指定は無視されます（指定がなかった場合と同じ動作をします）。

id

可

APIの要求を識別するための文字列（要求ID）を1〜2,048バイトで指定します。バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

要求IDは，cancelGetScheduleメソッドでキャンセルする処理を特定したい場合に指定します。

要求IDを指定した場合，cancelGetScheduleメソッドの引数に同じ要求IDを指定することで，本メソッドの処理だけをキャンセルすることができます。

要求IDを省略した場合，cancelGetScheduleメソッドの引数に要求IDを指定しないことで，本メソッドの処理をキャンセルすることができます。

キャンセルの詳細については，「2.3.29 cancelGetSheduleメソッド」を参照してください。

option

可

取得オプションを設定した予実績情報取得オプションクラスを指定します。

予実績情報取得オプションクラスの詳細については，「3.18 予実績情報取得オプションクラス（AjsCdGetScheduleOption）」を参照してください。

本引数を省略する場合は，nullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。

注※

例えば，引数beginと引数endで指定する範囲を1日とする場合は次のように指定します。なお，基準時間はgetCalendarメソッドで取得してください。

引数beginに指定する値

取得対象日のミリ秒値 + 基準時間のミリ秒値

引数endに指定する値

引数beginに指定した値 + 1日のミリ秒値（1日を23時間59分59秒とする場合は((24×60×60)−1)×1000ミリ秒）

(5)　戻り値

取得したユニットの情報を，ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

cancelGetScheduleメソッドによってキャンセルされた場合，例外クラス（AjsCdApiCancelException）を送出します。

(7)　注意事項

このメソッドで取得した情報には，ユニット名などの定義情報は含まれません。定義情報はgetDefinitionsUnderJobnetメソッドやsearchUnitメソッドなどで取得し，ユニットIDをキーにして該当する定義を求めてください。

予実績情報の取得は，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Managerに負荷がかかることがあります。JP1/AJS3 - Managerへの負荷を考慮して，取得する期間を検討してください。

本メソッドは，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Manager やネットワークに負荷がかかることがあります。また，世代数や対象ジョブネットの総ユニット数が増えるに従い，所要メモリ量と応答時間が増加します。

世代数や対象ジョブネットの総ユニット数が多い場合は，１回あたりの取得期間を複数回に短く分割して取得するなどを検討してください。

2.3.29　cancelGetScheduleメソッド

(1)　説明

キャンセルを要求します。

実行中のgetScheduleメソッドでの予実績取得を中止します。

(2)　形式

要求IDを指定しないキャンセルの場合

public boolean cancelGetSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName) throws AjsCdException

要求IDの指定によるキャンセルの場合

public boolean cancelGetSchedule(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String id) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

id

可

要求IDを指定してキャンセルする場合に指定します。

要求IDはgetScheduleメソッドで設定したものを指定します。

省略した場合は，getScheduleメソッドで要求IDを設定していない要求だけがキャンセルされます。

(5)　戻り値

キャンセル要求したかどうかをbooleanで返却します。

この値は，予実績取得をキャンセルできたかどうかではなく，予実績取得のキャンセル要求ができたかどうかを指します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

本APIはgetScheduleメソッドが対象となります。キャンセル対象の処理がない場合，戻り値には「false」を返却します。また，戻り値が「true」の場合でも，JP1/AJS3 - Managerのホストにキャンセル要求を送信したタイミングによっては（処理の開始前，処理の終了後など），キャンセルされないときがあります。

本APIとすれ違いでgetScheduleメソッドが開始した場合，処理はキャンセルされません（getScheduleメソッドは例外を送出しません）。処理をキャンセルするには，本APIを再発行してください。

実行中のgetScheduleメソッドをキャンセルできた場合でも，本APIは例外を送出せずに，正常終了します。なお，処理をキャンセルされたgetScheduleメソッドは例外を送出します。

本APIにより，実行中のgetScheduleメソッドに対して処理をキャンセルするのとほぼ同時にgetScheduleメソッドの処理が終了（cancelGetScheduleメソッドは正常終了）するケースの場合，getScheduleメソッドによるJP1/AJS3 - Managerからのデータ取得が完了しているタイミング以降では，getScheduleメソッドはメソッド内の後処理を続行して，例外を送出することなく正常終了します。

本APIの実行は，getScheduleメソッドと別スレッドで実行してください。

2.3.30　getCalendarメソッド

(1)　説明

指定されたジョブグループやルートジョブネットのカレンダー情報を取得します。

ルートジョブネットを指定した場合は，上位のジョブグループのカレンダー情報が取得されます。

取得できる情報は，上位のすべてのジョブグループのカレンダー情報がマージされた情報です。

スケジュールルールの［他のジョブグループのカレンダーを参照］を設定していても，参照先のジョブグループの情報には適用されません。

年月を指定して情報を取得する場合，取得できる範囲は，基準日から翌月の基準日の前日までです。

例えば，2012年12月を指定して本メソッドを呼び出した場合，基準日の指定により，取得できる範囲は次のようになります。

基準日が1日，月区分が当月の場合

取得できる範囲：12/1〜12/31

基準日が第2週目の水曜日，月区分が当月の場合

取得できる範囲：12/12〜1/8

ジョブグループやルートジョブネットのカレンダー情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のJP1/AJS3運用上のカレンダー定義について記載している個所を参照してください。

(2)　形式

年月を指定して情報を取得する場合

public AjsCdCalendar getCalendar(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String month) throws AjsCdException

期間を指定して情報を取得する場合

public AjsCdCalendar getCalendar(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String unitName,
　　java.lang.String begin,
　　java.lang.String end) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ジョブグループ

プランニンググループ

ルートジョブネット

ルートリモートジョブネット

なお，マネージャージョブグループは指定できません。

month

不可

取得したいカレンダー情報の年月を，「YYYYMM」形式の文字列で指定します。指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

指定する年月は，要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

begin

不可

取得するカレンダー情報の開始日を，「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

指定する日付は，要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

end

不可

取得するカレンダー情報の終了日を，「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜31（単位：日）です。

指定する日付は，要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

なお，本引数には引数beginで指定した日付以降の値を指定してください。それ以外の値を指定した場合は，例外を送出します。

(5)　戻り値

取得したカレンダー情報を，カレンダー情報インターフェース（AjsCdCalendar）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.31　getJobnetSummaryメソッド

(1)　説明

指定されたジョブネットのサマリー情報（指定した取得対象期間の実行予定のユニット数，実行が終了したユニット数，終了予定日時などのジョブネットの進捗状況に関係する情報）を取得します。

ジョブネットリリース機能を使用している場合は，リリース登録時に指定したリリースIDに対応したユニット定義の情報も取得します。

ログインしたJP1ユーザーに参照権限がないユニットが存在する場合は，例外を送出し，すべての情報を取得できません。ただし，指定したユニットの状態が未登録のときは，指定したユニットの配下に参照権限がないユニットが存在する場合でも例外を送出しません（世代数が0のサマリー情報全体インターフェース（AjsCdTotalSummary）を取得します）。

取得対象期間と取得対象世代

取得対象となる世代は，取得対象期間が次の条件のどれかを満たしている必要があります。

取得対象期間に開始時刻または開始予定時刻が含まれている。

取得対象期間に終了時刻または終了予定時刻が含まれている。

取得対象期間の間，常に実行中である

取得対象期間に当日以降を指定した場合は，擬似予定も取得対象となります。

取得対象期間をまたがった世代の場合は，その配下のユニットのうち取得対象期間に含まれないユニットは取得対象になりません。

なお，再実行したジョブネットの場合は，再実行開始日時ではなく開始日時を使用して判定されます。

起動条件付きジョブネットを指定する場合

起動条件付きジョブネットを指定した場合は，監視世代と実行世代の両方が取得対象となります。

取得対象となるユニットは，実行世代の場合は通常のルートジョブネットと同様にその世代の開始日時または終了日時が取得対象の範囲に含まれるかどうかで判定されますが，監視世代の場合は監視世代の状態によって次のように判定されます。

監視世代の状態

取得対象ユニット

開始時刻待ち

保留中

ルートジョブネットおよび配下のすべてのユニット

監視中

監視正常終了

監視打ち切り終了

監視中断

監視未起動終了

繰り返し未実行

ルートジョブネットだけ

未計画

すべてのユニットが対象外

また，監視世代が擬似予定の場合も，ルートジョブネットおよび配下のすべてのユニットが取得対象となります。

取得対象となるユニットの総数（予定ユニット数）

次に示すユニットはカウント対象外となります。

監視世代が次の状態にある起動条件付きジョブネットの配下のユニット

・監視中

・監視正常終了

・監視未起動終了

・監視打ち切り終了

・監視中断

・繰り返し未実行

ジョブネットコネクタの接続先ジョブネット，およびその配下のユニット

ルートリモートジョブネットおよびネストリモートジョブネットの配下のユニット

次の状態のユニット

・未登録

・未計画

・計画未実行

・閉塞

・未実行終了

・繰り越し未実行（実行予定なし）

終了ユニット数と予定ユニット数

終了ユニット数と予定ユニット数の例を次に説明します。

（例1）取得対象期間に3回実行するジョブネットの場合

この例の場合，取得対象期間に実行される予定のユニットの数は，ジョブが9個とジョブネットが3個（世代1〜世代3）の合計12個になります。現在時刻では世代2のジョブAまでが正常終了していて，後続のジョブBが実行中のため，終了状態のユニットの数はジョブが4個にジョブネットが1個（世代1）の合計5個になります。

（例2）関連線で接続されているジョブが異常終了した場合

この例の場合，ジョブネット実行前の待ち状態のジョブネットでは（上図），終了ユニット数/実行予定ユニット数は「0/5」となります。

ジョブネットの実行が開始し，ジョブ2が異常終了すると（下図），後続のジョブ（ジョブ3およびジョブ4）が未実行終了になるため，終了ユニット数/実行予定ユニット数は「1/3」となります。

また，異常終了ユニット数は「2」となるため，異常終了したことを確認できます。

（例3）リカバリーユニットを含むジョブネットの場合

この例の場合，ジョブネット実行前の待ち状態のジョブネットでは（上図），終了ユニット数/実行予定ユニット数は「0/5」となります。

ジョブネットの実行が開始し，ジョブ2が正常終了すると（下図），ジョブ2の後続のリカバリージョブ（ジョブ4）が「未実行終了」状態でジョブネットの実行が終了しますが，終了ユニット数/実行予定ユニット数は「4/4」となります。

このように，正常終了したときは，実行されないリカバリーユニットを取得対象外にして，終了ユニット数と実行予定ユニット数を取得します。

ジョブネットのサマリー情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のJP1/AJS3 - Viewでの監視について記載している個所を参照してください。

(2)　形式

public AjsCdTotalSummary getJobnetSummary(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　long begin,
　　long end,
　　AjsCdGetSummaryOption option) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

ルートリモートジョブネット

プランニンググループ

begin※

不可

サマリーを取得する期間の開始時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。

指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。

なお，本引数には引数endで指定した時間以前の値を指定してください。それ以外の値を指定した場合は，例外を送出します。

end※

不可

サマリーを取得する期間の終了時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。

指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。

なお，本引数には引数beginで指定した時間以降の値を指定してください。それ以外の値を指定した場合は，例外を送出します。

option

可

取得オプションを設定したサマリー情報取得オプションクラスを指定します。

サマリー情報取得オプションクラスの詳細については，「3.22 サマリー情報取得オプションクラス（AjsCdGetSummaryOption）」を参照してください。

本引数を省略する場合は，nullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。

注※

例えば，引数beginと引数endで指定する範囲を1日とする場合は次のように指定します。なお，基準時間はgetCalendarメソッドで取得してください。

引数beginに指定する値

取得対象日のミリ秒値 + 基準時間のミリ秒値

引数endに指定する値

引数beginに指定した値 + 1日のミリ秒値（1日を23時間59分59秒とする場合は((24×60×60)−1×1000)ミリ秒）

(5)　戻り値

取得したユニットの情報を，サマリー情報全体インターフェース（AjsCdTotalSummary）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

接続先JP1/AJS3 - Managerが標準構成以外の場合，このメソッドは例外クラス（AjsCdException）を送出します。

サマリー情報の取得は，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Managerに負荷がかかることがあります。JP1/AJS3 - Managerへの負荷を考慮して，取得する期間を検討してください。

本メソッドは，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Manager やネットワークに負荷がかかることがあります。また，世代数や対象ジョブネットの総ユニット数が増えるに従い，所要メモリ量と応答時間が増加します。

世代数や対象ジョブネットの総ユニット数が多い場合は，１回あたりの取得期間を複数回に短く分割して取得するなどを検討してください。

2.3.32　getJobnetReleaseInfoメソッド

(1)　説明

ルートジョブネットに設定されているリリース情報を取得します。

ルートジョブネットに設定されているリリース情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 運用ガイド」の実行登録中にジョブネットの定義を切り替える方法について記載している個所，およびリリース登録後のジョブネットの定義の状態について記載している個所を参照してください。

(2)　形式

public java.util.List<AjsCdJobnetReleaseInfo> getJobnetReleaseInfo(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName) throws AjsCdException

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

JP1_AJS_Admin権限

JP1_AJS_Manager権限

JP1_AJS_Editor権限

JP1_AJS_Operator権限

JP1_AJS_Guest権限

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。

ルートジョブネット

(5)　戻り値

取得したリリース情報を，リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

リリース情報が存在しない場合は，要素数0個のListインターフェースを実装したクラスのインスタンスを返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

(7)　注意事項

接続先JP1/AJS3 - Managerのバージョンが標準構成以外の場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.33　enumSchServiceメソッド

(1)　説明

スケジューラーサービスの一覧を取得します。

スケジューラーサービスの詳細については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（システム構築編）」のスケジューラーサービスに関する環境設定，およびスケジューラーサービスの多重起動について記載している個所を参照してください。

(2)　形式

public java.util.List<AjsCdSchServiceDef> enumSchService(
　　java.lang.String manager) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

(5)　戻り値

スケジューラーサービスの情報を，スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.34　getSchServiceInfoメソッド

(1)　説明

スケジューラーサービスの情報（文字コード，DB種別などに指定できる文字数の変更設定）を取得します。

スケジューラーサービスの詳細については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（システム構築編）」のスケジューラーサービスに関する環境設定，およびスケジューラーサービスの多重起動について記載している個所を参照してください。

(2)　形式

public AjsCdSchServiceInfo getSchServiceInfo(
　　java.lang.String manager,
　　java.lang.String serviceName) throws AjsCdException

(3)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

(4)　戻り値

情報取得の結果を，スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）を実装したクラスのインスタンスとして返却します。

(5)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.35　getAJSManagerInfoメソッド

(1)　説明

JP1/AJS3 - Managerの情報（バージョン，OS情報，データベース構成）を取得します。

JP1/AJS3 - Managerの詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のJP1/AJS3のプログラム構成，およびJP1/AJS3のデータベース構成の種類について記載している個所を参照してください。

(2)　形式

public AjsCdAJSManagerInfo getAJSManagerInfo(
　　java.lang.String manager) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

(5)　戻り値

情報取得の結果を，JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）を実装したクラスのインスタンスとして返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.36　getCharCodeメソッド

(1)　説明

文字コードを取得します。

APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを取得します。

JP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードは，次の表に示す優先順位に従って決定されます。

表2‒4　文字コード変換に使用するスケジューラーサービスの文字コード

優先順位

文字コード設定

1

setCharCodeメソッドで設定した文字コード

2

setCharCodeメソッドで文字コードを設定していない場合，JP1/AJS3 - Managerからの文字コード取得有無オプションに従います。

文字コード取得有無オプションの詳細については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - SDKの環境設定ファイルの「文字コードの取得（getmanager_charcode）」について記載している個所を参照してください。

オプションが「yes」の場合（デフォルト）

JP1/AJS3 - Managerから取得したスケジューラーサービスの文字コードをJava規定のエンコーディングセットにマッピングした文字コード

オプションが「no」の場合

デフォルトJP1/AJS3 - Manager文字コード

なお，接続先のスケジューラーサービスの文字コードを接続中に変更した場合は，再度ログインし直してください。ログインし直さない場合は，変更前の情報が取得されるときがあります。

(2)　形式

public java.lang.String getCharCode(
　　java.lang.String manager,
　　java.lang.String serviceName) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

(5)　戻り値

「表 2-4 文字コード変換に使用するスケジューラーサービスの文字コード」に従って，文字コードをJava規定のエンコーディングセット名で返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

2.3.37　setCharCodeメソッド

(1)　説明

文字コードを設定します。

APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを設定します。

文字コード変換に使用するスケジューラーサービスの文字コードの詳細については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - SDKの環境設定ファイルの「文字コードの取得（getmanager_charcode）」について記載している個所を参照してください。

本メソッドで設定した値は，接続先JP1/AJS3 - Managerからログアウトするまで有効です。

本メソッドで文字コードを設定しなかった場合は「2.3.36 getCharCodeメソッド」で示す内容に従って，使用する文字コードが設定されます。

(2)　形式

public void setCharCode(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.String charCode) throws AjsCdException

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

charCode

不可

文字コード（Java規定のエンコーディングセット名）を文字列で指定します。

(5)　戻り値

なし。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

3　データ型クラス

データ型クラスのクラス，インターフェース，およびメソッドについて説明します。

3.1　ユニット情報インターフェース（AjsCdUnitInfo）

ユニット情報インターフェース（AjsCdUnitInfo）は，ユニットの情報を保持するインターフェースです。

ユニット情報インターフェースを実装したクラスのインスタンスは，次に示すメソッドで取得できます。

ユニット検索結果インターフェース（AjsCdSearchResult）のgetUnitInfoメソッド

詳細については，「3.8.1 getUnitInfoメソッド」を参照してください。

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）のgetUnitInfoメソッド

詳細については，「3.12.1 getUnitInfoメソッド」を参照してください。

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）のgetUnitInfoメソッド

詳細については，「3.13.1 getUnitInfoメソッド」を参照してください。

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）のgetUnitInfoメソッド

詳細については，「3.15.1 getUnitInfoメソッド」を参照してください。

世代単位の予実績情報インターフェース（AjsCdSchedule）のgetUnitInfoメソッド

詳細については，「3.20.1 getUnitInfoメソッド」を参照してください。

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のgetUnitInfoメソッド

詳細については，「3.25.2 getUnitInfoメソッド」を参照してください。

ユニット情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdUnitInfo

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒1　ユニット情報インターフェース（AjsCdUnitInfo）のメソッド一覧

メソッドの概要

public java.lang.String

getUnitName()

ユニット名称（完全名）を取得します。

public java.lang.String

getSimpleUnitName()

ユニット名称（単体名）を取得します。

public java.lang.String

getUnitComment()

ユニットのコメントを取得します。

public Type

getUnitType()

ユニットの種別を取得します。

public java.lang.String

getCustomJobType()

カスタムジョブの種別を取得します。

public java.lang.String

getOwner()

ユニットに定義されている所有者名を取得します。

public java.lang.String

getJP1ResourceGroup()

ユニットに定義されているJP1資源グループ名を取得します。

public java.lang.String

getExecAgent()

ユニット「実行エージェント」に定義されている実行エージェント名または実行エージェントグループ名を取得します。

public java.lang.String

getExecFileName()

ユニットに定義されている実行ファイル名またはスクリプトファイル名を取得します。

public java.lang.String

getParameters()

PCジョブ，QUEUEジョブ，またはUNIXジョブに定義されているパラメーターを取得します。

public RegisterStatus

getRegisterStatus()

ユニットの登録状態を取得します。

public int

getUnitID()

ユニットIDを取得します。

public AjsCdUnitStatus

getUnitStatus()

登録済みユニットの実行状態および実行結果の詳細情報を取得します。

public boolean

isScenarioUnit()

JP1/AJS2 - Scenario Operationから登録されたシナリオかどうかを取得します。

public boolean

isRecoveryUnit()

ユニットにリカバリー属性が設定されているかどうかを取得します。

public int

getHorizontalPosition()

ユニットの水平方向の位置情報を取得します。

public int

getVerticalPosition()

ユニットの垂直方向の位置情報を取得します。

public AjsCdJobnetReleaseInfo

getJobnetReleaseInfo()

リリース情報を取得します。

public boolean

isWait()

待ち合わせ条件付きユニットかどうかを取得します。

public boolean

isRetry()

リトライ設定のありなしを取得します。

public int

getMaximumRetryTimes()

最大リトライ回数を取得します。

public int

getRetryInterval()

リトライ間隔を取得します。

public boolean

isJobnetReleaseUnit()

リリース登録されているかどうかを取得します。

なお，取得するインターフェースによって，メソッドで取得できるユニットの情報に差異があります。詳細については，「付録C メソッドで取得できるユニット情報の差異」を参照してください。

3.1.1　getUnitNameメソッド

(1)　説明

ユニット名称（完全名）を取得します。

(2)　形式

public java.lang.String getUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット名称の完全名を1〜930バイトの文字列で返却します。

(6)　例外

なし。

3.1.2　getSimpleUnitNameメソッド

(1)　説明

ユニット名称（単体名）を取得します。

(2)　形式

public java.lang.String getSimpleUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット名称の単体名を0〜30バイトの文字列で返却します。情報がないユニットの場合は長さ0バイトの文字列を返却します。

(6)　例外

なし。

3.1.3　getUnitCommentメソッド

(1)　説明

ユニットのコメントを取得します。

(2)　形式

public java.lang.String getUnitComment()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットのコメントを0〜80バイトの文字列で返却します。ユニットにコメントが定義されていない場合は空文字列を返却します。

(6)　例外

なし。

3.1.4　getUnitTypeメソッド

(1)　説明

ユニットの種別を取得します。

(2)　形式

public Type getUnitType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの種別をTypeで返却します。

Typeの詳細については，「付録A.2 (1)Type」を参照してください。

(6)　例外

なし。

3.1.5　getCustomJobTypeメソッド

(1)　説明

カスタムジョブの種別を取得します。

getUnitTypeメソッドの戻り値がカスタムジョブ（CUSTOM）の場合で，カスタムジョブの種別を特定する必要があるときに使用してください。

(2)　形式

public java.lang.String getCustomJobType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

カスタムジョブの種別を文字列で返却します。当該ユニットがカスタムジョブでない場合，このメソッドは空文字列を返却します。

項番

カテゴリ

返却する値※1

1

標準カスタムジョブ

CUSTOM_PC_JP1FTP

2

CUSTOM_PC_JP1AMR3

3

CUSTOM_PC_JP1AMR3BW

4

CUSTOM_PC_JP1AMOAP

5

CUSTOM_PC_MFJOB

6

CUSTOM_PC_VOS3JOB

7

CUSTOM_PC_VOS1JOB

8

CUSTOM_PC_VOS1NET

9

CUSTOM_PC_VOSKJOB

10

CUSTOM_PC_VOSKNET

11

CUSTOM_PC_DMSV

12

CUSTOM_PC_COSMNGSV

13

CUSTOM_PC_COSMNGAP

14

CUSTOM_PC_WS_PC

15

CUSTOM_PC_WSUSR_PC

16

CUSTOM_PC_WS_UX

17

CUSTOM_PC_WSUSR_UX

18

CUSTOM_PC_AJSPDFS

19

CUSTOM_PC_ADSHPC

20

CUSTOM_PC_ADSHUX

21

ユーザーカスタムジョブ

カスタムPCジョブ

CUSTOM_PC_USER_XXXX※2

22

カスタムUNIXジョブ

CUSTOM_UX_USER_XXXX※2

注※1

クラス名はJP1/AJS3が連携するプログラムごとに異なります。詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のカスタムジョブの登録情報について記載している個所を参照してください。

注※2

「XXXX」はカスタムジョブ登録時にユーザーが指定した任意の文字列です。

(6)　例外

なし。

3.1.6　getOwnerメソッド

(1)　説明

ユニットに定義されている所有者名を取得します。

(2)　形式

public java.lang.String getOwner()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

所有者名を0〜31バイトの文字列で返却します。ユニットに所有者が定義されていない場合は，空文字列を返却します。

(6)　例外

なし。

3.1.7　getJP1ResourceGroupメソッド

(1)　説明

ユニットに定義されているJP1資源グループ名を取得します。

(2)　形式

public java.lang.String getJP1ResourceGroup()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1資源グループ名を0〜63バイトの文字列で返却します。ユニットにJP1資源グループが定義されていない場合は，空文字列を返却します。

(6)　例外

なし。

3.1.8　getExecAgentメソッド

(1)　説明

ユニット「実行エージェント」に定義されている実行エージェント名または実行エージェントグループ名を取得します。

(2)　形式

public java.lang.String getExecAgent()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行エージェント名または実行エージェントグループ名を0〜255バイトの文字列で返却します。ユニットに実行エージェントが定義されていない場合は，空文字列を返却します。

(6)　例外

なし。

3.1.9　getExecFileNameメソッド

(1)　説明

ユニットに定義されている実行ファイル名またはスクリプトファイル名を取得します。

(2)　形式

public java.lang.String getExecFileName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行ファイル名またはスクリプトファイル名を0〜511バイトの文字列で返却します。実行ファイル名，スクリプトファイル名が定義されていない場合，またはユニットがUNIXジョブ，PCジョブ，QUEUEジョブ以外の場合は，空文字列を返却します。

(6)　例外

なし。

3.1.10　getParametersメソッド

(1)　説明

PCジョブ，QUEUEジョブ，またはUNIXジョブに定義されているパラメーターを取得します。

(2)　形式

public java.lang.String getParameters()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

パラメーターを0〜1023バイトの文字列で返却します。パラメーターが定義されていない場合，またはユニットがUNIXジョブ，PCジョブ，QUEUEジョブ以外の場合は，空文字列を返却します。

(6)　例外

なし。

3.1.11　getRegisterStatusメソッド

(1)　説明

ユニットの登録状態を取得します。

(2)　形式

public RegisterStatus getRegisterStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの登録状態をRegisterStatusで返却します。

RegisterStatusの詳細については，「付録A.2 (2)RegisterStatus」を参照してください。

(6)　例外

なし。

3.1.12　getUnitIDメソッド

(1)　説明

ユニットIDを取得します。

(2)　形式

public int getUnitID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットIDを返却します。

(6)　例外

なし。

3.1.13　getUnitStatusメソッド

(1)　説明

登録済みユニットの実行状態および実行結果の詳細情報を取得します。

(2)　形式

public AjsCdUnitStatus getUnitStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの実行状態，および実行結果の詳細情報を，ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）を実装したクラスのインスタンスとして返却します。

取得する世代のユニットの実行状態および実行結果の詳細情報がない場合は，nullを返却します。

(6)　例外

なし。

3.1.14　isScenarioUnitメソッド

(1)　説明

JP1/AJS2 - Scenario Operationから登録されたシナリオかどうかを取得します。

(2)　形式

public boolean isScenarioUnit()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1/AJS2 - Scenario Operationから登録されたシナリオの場合，「true」を返却します。

JP1/AJS2 - Scenario Operationから登録されたシナリオではない場合，「false」を返却します。

(6)　例外

なし。

3.1.15　isRecoveryUnitメソッド

(1)　説明

ユニットにリカバリー属性が設定されているかどうかを取得します。

(2)　形式

public boolean isRecoveryUnit()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

このユニットにリカバリー属性が設定されている場合，「true」を返却します。

このユニットにリカバリー属性が設定されていない場合，「false」を返却します。

(6)　例外

なし。

3.1.16　getHorizontalPositionメソッド

(1)　説明

ユニットの水平方向の位置情報を取得します。

(2)　形式

public int getHorizontalPosition()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット位置の列番号を0以上の数値で返却します。

列番号とは，マップ情報の表示エリアの左から水平右方向に1ずつ増える値です。具体的な利用方法については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のジョブの実行ステータスをジョブフロー形式で監視する画面の「マップ表示」について記載している個所を参照してください。

(6)　例外

なし。

3.1.17　getVerticalPositionメソッド

(1)　説明

ユニットの垂直方向の位置情報を取得します。

(2)　形式

public int getVerticalPosition()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット位置の行番号を0以上の数値で返却します。

行番号とは，マップ情報の表示エリアの左から垂直下方向に1ずつ増える値です。具体的な利用方法については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のジョブの実行ステータスをジョブフロー形式で監視する画面の「マップ表示」について記載している個所を参照してください。

(6)　例外

なし。

3.1.18　getJobnetReleaseInfoメソッド

(1)　説明

リリース情報を取得します。

(2)　形式

public AjsCdJobnetReleaseInfo getJobnetReleaseInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリース情報を，リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）を実装したクラスのインスタンスとして返却します。

ユニットがリリース先ジョブネットまたはその配下のユニットでない場合，および情報がないユニットの場合はnullを返却します。

(6)　例外

なし。

3.1.19　isWaitメソッド

(1)　説明

待ち合わせ条件付きユニットかどうかを取得します。

(2)　形式

public boolean isWait()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

待ち合わせ条件付きユニットの場合，「true」を返却します。待ち合わせ条件付きユニットではない場合，「false」を返却します。

(6)　例外

なし。

3.1.20　isRetryメソッド

(1)　説明

リトライ設定のありなしを取得します。

(2)　形式

public boolean isRetry()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リトライ設定ありの場合，「true」を返却します。リトライ設定なしの場合，「false」を返却します。

次の場合は「false」が返却されます。

リトライ設定されていない場合

UNIXジョブ，PCジョブ，QUEUEジョブ，標準カスタムジョブ，カスタムPCジョブ，カスタムUNIXジョブ，またはオペレーショジョブ以外のユニットの場合

JP1/AJS3 - Managerのデータベースが互換用ISAM構成の場合

(6)　例外

なし。

3.1.21　getMaximumRetryTimesメソッド

(1)　説明

最大リトライ回数を取得します。

(2)　形式

public int getMaximumRetryTimes()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

最大リトライ回数を数値で返却します。リトライ設定がされていない場合，および情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.1.22　getRetryIntervalメソッド

(1)　説明

リトライ間隔を取得します。

(2)　形式

public int getRetryInterval()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リトライ間隔を数値で返却します。リトライ設定されていない場合，および情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.1.23　isJobnetReleaseUnitメソッド

(1)　説明

ユニットがリリース登録されているかどうかを取得します。

(2)　形式

public boolean isJobnetReleaseUnit()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリース登録されている場合，「true」を返却します。リリース登録されていない場合，「false」を返却します。

また，戻り値が「true」の場合でも，getJobnetReleaseInfoメソッドでリリース情報を取得できないときがあります。

(6)　例外

なし。

3.2　ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）

ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）は，ユニットの実行状態および実行結果の詳細な情報を保持するインターフェースです。

ユニットの実行状態および実行結果の詳細情報インターフェースを実装したクラスのインスタンスは，次に示すメソッドで取得できます。

AjsCdApiインターフェースのgetUnitStatusメソッド

詳細については，「2.3.21 getUnitStatusメソッド」を参照してください。

ユニット検索結果インターフェース（AjsCdSearchResult）のgetUnitInfoメソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetUnitStatusメソッド

詳細については，「3.8.1 getUnitInfoメソッド」および「3.1.13 getUnitStatusメソッド」を参照してください。

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）のgetStatusInfoメソッドおよびgetResultInfoメソッド

詳細については，「3.12.2 getStatusInfoメソッド」および「3.12.3 getResultInfoメソッド」を参照してください。

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）のgetUnitInfoメソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetUnitStatusメソッド

詳細については，「3.15.1 getUnitInfoメソッド」および「3.1.13 getUnitStatusメソッド」を参照してください。

世代単位の予実績情報インターフェース（AjsCdSchedule）のgetUnitInfoメソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetUnitStatusメソッド

詳細については，「3.20.1 getUnitInfoメソッド」および「3.1.13 getUnitStatusメソッド」を参照してください。

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のgetUnitInfoメソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetUnitStatusメソッド

詳細については，「3.25.2 getUnitInfoメソッド」および「3.1.13 getUnitStatusメソッド」を参照してください。

ユニットの実行状態および実行結果の詳細情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdUnitStatus

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒2　ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）のメソッド一覧

メソッドの概要

public java.lang.String

getUnitName()

ユニット名称（完全名）を取得します。

public java.lang.String

getSimpleUnitName()

ユニット名称（単体名）を取得します。

public java.lang.String

getExecID()

実行IDを取得します。

public Status

getStatus()

ユニットの状態を取得します。

public long

getSchStartTime()

開始予定日時を取得します。

public long

getStartTime()

開始日時を取得します。

public long

getReStartTime()

再実行開始日時を取得します。

public long

getEndTime()

終了日時を取得します。

public DelayStart

getStartDelayStatus()

自身の開始遅延有無を取得します。

public DelayStart

getNestStartDelayStatus()

配下の開始遅延有無を取得します。

public DelayEnd

getEndDelayStatus()

自身の終了遅延有無を取得します。

public DelayEnd

getNestEndDelayStatus()

配下の終了遅延有無を取得します。

public long

getStartDelayTime()

開始遅延日時を取得します。

public long

getEndDelayTime()

終了遅延日時を取得します。

public ChangeType

getChangeType()

計画一時変更情報を取得します。

public HoldAttr

getHoldAttr()

保留属性を取得します。

public long

getRegisterTime()

ジョブ登録日時を取得します。

public int

getJobNumber()

ジョブ番号を取得します。

public int

getRetCode()

終了コードを取得します。

public java.lang.String

getExecHost()

実行ホスト名を取得します。

public HoldPlan

getHoldPlan()

保留予定の有無を取得します。

public ExecutionType

getExecutionType()

登録種別を取得します。

public int

getStartConditionTimes()

起動条件の有効範囲の回数を取得します。

public long

getStartConditionPeriod()

起動条件の有効範囲の時間を取得します。

public TimeType

getStartConditionPeriodType()

起動条件の有効範囲の時間の種別を取得します。

public RetryStatus

getRetryStatus()

リトライ状態を取得します。

public int

getRetryTimes()

リトライ実行回数を取得します。

public EnumSet<StatusInSummary>

getStatusInSummary()

サマリーでカウントする状態を取得します。

public long

getExecDateBaseTime()

ルートジョブネットの実行日の基準時刻を取得します。

なお，取得するインターフェースによって，メソッドで取得できるユニットの情報に差異があります。詳細については，「付録C メソッドで取得できるユニット情報の差異」を参照してください。

3.2.1　getUnitNameメソッド

(1)　説明

ユニット名称（完全名）を取得します。

(2)　形式

public java.lang.String getUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット名称の完全名を1〜930バイトの文字列で返却します。

(6)　例外

なし。

3.2.2　getSimpleUnitNameメソッド

(1)　説明

ユニット名称（単体名）を取得します。

(2)　形式

public java.lang.String getSimpleUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット名称の単体名を0〜30バイトの文字列で返却します。情報がないユニットの場合は長さ0バイトの文字列を返却します。

(6)　例外

なし。

3.2.3　getExecIDメソッド

(1)　説明

実行IDを取得します。

(2)　形式

public java.lang.String getExecID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行IDを「@［mmmm］｛A〜Z｝nnnn」の形式で返却します。

(6)　例外

なし。

3.2.4　getStatusメソッド

(1)　説明

ユニットの状態を取得します。

(2)　形式

public Status getStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

状態をStatusで返却します。

Statusの詳細については，「付録A.3 (1)Status」を参照してください。

(6)　例外

なし。

3.2.5　getSchStartTimeメソッド

(1)　説明

開始予定日時を取得します。

(2)　形式

public long getSchStartTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

開始予定日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。

(6)　例外

なし。

3.2.6　getStartTimeメソッド

(1)　説明

開始日時を取得します。

ただし，開始していないユニットの場合は，開始予定日時が取得されます。対象となるのは，getScheduleメソッドまたはgetJobnetSummaryメソッドで取得したユニットです。

getScheduleメソッドで取得したユニットの場合

「実行シミュレーションを行う」を指定したとき

実行シミュレーションから算出した開始予定日時を取得します。

「実行シミュレーションを行わない」を指定したとき

ジョブネットのスケジュールルールに基づいた開始予定日時を取得します。

ただし，ジョブネット配下の個々のユニットはシミュレーションされないで，ジョブネットと同じ開始予定日時を取得します。

getJobnetSummaryメソッドで取得したユニットの場合

実行シミュレーションから算出した開始予定日時を取得します。

(2)　形式

public long getStartTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

開始日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。

(6)　例外

なし。

3.2.7　getReStartTimeメソッド

(1)　説明

再実行開始日時を取得します。

(2)　形式

public long getReStartTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

再実行開始日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.2.8　getEndTimeメソッド

(1)　説明

終了日時を取得します。

ただし，終了していないユニットの場合は，終了予定日時が取得されます。対象となるのは，getScheduleメソッドまたはgetJobnetSummaryメソッドで取得したユニットです。

getScheduleメソッドで取得したユニットの場合

「実行シミュレーションを行う」を指定したとき

実行シミュレーションから算出した終了予定日時を取得します。

「実行シミュレーションを行わない」を指定したとき

「初回実行時間」を実行所要時間として算出した終了予定日時を取得します。

ただし，ジョブネット配下の個々のユニットはシミュレーションされないで，ジョブネットと同じ終了予定日時を取得します。

getJobnetSummaryメソッドで取得したユニットの場合

実行シミュレーションから算出した終了予定日時を取得します。

(2)　形式

public long getEndTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

終了日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。ユニットが終了していない場合は「-1」を返却します

(6)　例外

なし。

3.2.9　getStartDelayStatusメソッド

(1)　説明

自身の開始遅延有無を取得します。

(2)　形式

public DelayStart getStartDelayStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

自身の開始遅延有無をDelayStartで返却します。

DelayStartの詳細については，「付録A.3 (2)DelayStart」を参照してください。

(6)　例外

なし。

3.2.10　getNestStartDelayStatusメソッド

(1)　説明

配下の開始遅延有無を取得します。

(2)　形式

public DelayStart getNestStartDelayStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

配下の開始遅延有無をDelayStartで返却します。

DelayStartの詳細については，「付録A.3 (2)DelayStart」を参照してください。

(6)　例外

なし。

3.2.11　getEndDelayStatusメソッド

(1)　説明

自身の終了遅延有無を取得します。

(2)　形式

public DelayEnd getEndDelayStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

自身の終了遅延有無をDelayEndで返却します。

DelayEndの詳細については，「付録A.3 (3)DelayEnd」を参照してください。

(6)　例外

なし。

3.2.12　getNestEndDelayStatusメソッド

(1)　説明

配下の終了遅延有無を取得します。

(2)　形式

public DelayEnd getNestEndDelayStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

配下の終了遅延有無をDelayEndで返却します。

DelayEndの詳細については，「付録A.3 (3)DelayEnd」を参照してください。

(6)　例外

なし。

3.2.13　getStartDelayTimeメソッド

(1)　説明

開始遅延日時を取得します。

(2)　形式

public long getStartDelayTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

開始遅延日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.2.14　getEndDelayTimeメソッド

(1)　説明

終了遅延日時を取得します。

(2)　形式

public long getEndDelayTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

終了遅延日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.2.15　getChangeTypeメソッド

(1)　説明

計画一時変更情報を取得します。

(2)　形式

public ChangeType getChangeType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

計画一時変更の有無をChangeTypeで返却します。

ChangeTypeの詳細については，「付録A.3 (4)ChangeType」を参照してください。

(6)　例外

なし。

3.2.16　getHoldAttrメソッド

(1)　説明

保留属性を取得します。

(2)　形式

public HoldAttr getHoldAttr()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

保留属性をHoldAttrで返却します。

HoldAttrの詳細については，「付録A.3 (5)HoldAttr」を参照してください。

(6)　例外

なし。

3.2.17　getRegisterTimeメソッド

(1)　説明

ジョブ登録日時を取得します。

(2)　形式

public long getRegisterTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ジョブ登録日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.2.18　getJobNumberメソッド

(1)　説明

ジョブ番号を取得します。

(2)　形式

public int getJobNumber()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ジョブ番号を数値で返却します。情報がないユニットの場合は「0」を返却します。

(6)　例外

なし。

3.2.19　getRetCodeメソッド

(1)　説明

終了コードを取得します。

(2)　形式

public int getRetCode()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

終了コードを数値で返却します。情報がないユニットの場合は「0」を返却します。

(6)　例外

なし。

3.2.20　getExecHostメソッド

(1)　説明

実行ホスト名を取得します。

(2)　形式

public java.lang.String getExecHost()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行ホスト名を0〜255バイトの文字列で返却します。ユニットが開始していない場合は空文字列を返却します。

(6)　例外

なし。

3.2.21　getHoldPlanメソッド

(1)　説明

保留予定の有無を取得します。

(2)　形式

public HoldPlan getHoldPlan()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

保留予定の有無をHoldPlanで返却します。

HoldPlanの詳細については，「付録A.3 (6)HoldPlan」を参照してください。

(6)　例外

なし。

3.2.22　getExecutionTypeメソッド

(1)　説明

登録種別を取得します。

(2)　形式

public ExecutionType getExecutionType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

登録種別をExecutionTypeで返却します。

ExecutionTypeの詳細については，「付録A.3 (7)ExecutionType」を参照してください。

(6)　例外

なし。

3.2.23　getStartConditionTimesメソッド

(1)　説明

起動条件を使用している場合に起動条件の有効範囲の回数を取得します。

(2)　形式

public int getStartConditionTimes()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

起動条件の有効範囲の回数を数値で返却します。回数が無制限の場合は「0」を返却します。

起動条件の有効範囲の回数を使用していない場合は「-1」を返却します。

(6)　例外

なし。

3.2.24　getStartConditionPeriodメソッド

(1)　説明

起動条件を使用している場合に起動条件の有効範囲の時間を取得します。

(2)　形式

public long getStartConditionPeriod()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

起動条件の有効範囲の時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒で返却します。

getStartConditionPeriodTypeメソッドで取得した時間種別TimeTypeが「ABSOLUTE」または「RELATIVE」の場合は，起動条件の有効範囲の時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒で返却します。

getStartConditionPeriodTypeメソッドで取得した時間種別TimeTypeが「ABSOLUTE」または「RELATIVE」以外の場合は「-1」を返却します。

(6)　例外

なし。

3.2.25　getStartConditionPeriodTypeメソッド

(1)　説明

起動条件を使用している場合に起動条件の有効範囲の時間の種別を取得します。

(2)　形式

public TimeType getStartConditionPeriodType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

起動条件の有効範囲の時間の種別をTimeTypeで返却します。

TimeTypeの詳細については，「付録A.3 (8)TimeType」を参照してください。

起動条件の有効範囲の時間の種別を使用していない場合は「NO」を返却します。

(6)　例外

なし。

3.2.26　getRetryStatusメソッド

(1)　説明

リトライ状態を取得します。

(2)　形式

public RetryStatus getRetryStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リトライ状態をRetryStatusで返却します。

RetryStatusの詳細については，「付録A.3 (9)RetryStatus」を参照してください。

(6)　例外

なし。

3.2.27　getRetryTimesメソッド

(1)　説明

リトライ実行回数を取得します。

(2)　形式

public int getRetryTimes()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リトライ実行回数を返却します。

次の場合は「0」が返却されます。

リトライ設定しているが，一度もリトライ実行されていない場合

リトライ設定されていない場合

UNIXジョブ，PCジョブ，QUEUEジョブ，標準カスタムジョブ，カスタムPCジョブ，カスタムUNIXジョブ，またはオペレーショジョブ以外のユニットの場合

JP1/AJS3 - Managerのデータベースが互換用ISAM構成の場合

(6)　例外

なし。

3.2.28　getStatusInSummaryメソッド

(1)　説明

サマリーでカウントする状態を取得します。

(2)　形式

public EnumSet<StatusInSummary> getStatusInSummary()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

サマリーでカウントする状態をEnumSet<StatusInSummary>で返却します。

StatusInSummaryの詳細については，「付録A.3 (10)StatusInSummary」を参照してください。

(6)　例外

なし。

3.2.29　getExecDateBaseTimeメソッド

(1)　説明

ルートジョブネットの実行日の基準時刻を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で取得します。

(2)　形式

public long getExecDateBaseTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ルートジョブネットの実行日の基準時刻を返却します。

(6)　例外

なし。

3.3　リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）は，ルートジョブネットに設定されているリリース情報を保持するクラスです。

リリース情報取得結果インターフェースを実装したクラスのインスタンスは，次に示すメソッドで取得できます。

ユニット検索結果インターフェース（AjsCdSearchResult）のgetUnitInfo メソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetJobnetReleaseInfo メソッド

詳細については，「3.8.1 getUnitInfo メソッド」および「3.1.18 getJobnetReleaseInfo メソッド」を参照してください。

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のgetUnitInfo メソッドで取得したユニット情報インターフェース（AjsCdUnitInfo）のgetJobnetReleaseInfo メソッド

詳細については，「3.25.2 getUnitInfo メソッド」および「3.1.18 getJobnetReleaseInfo メソッド」を参照してください。

AjsCdApiインターフェースのgetJobnetReleaseInfoメソッド

詳細については，「2.3.32 getJobnetReleaseInfo メソッド」を参照してください。

リリース情報取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdJobnetReleaseInfo

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒3　リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）のメソッド一覧

メソッドの概要

public java.lang.String

getReleaseID()

リリースIDを取得します。

public long

getReleaseTime()

リリース日時を取得します。

public java.lang.String

getReleaseComment()

リリースコメントを取得します。

public ReleaseStatus

getReleaseStatus()

リリース状態を取得します。

public java.lang.String

getSourceUnitName()

リリース元ジョブネット完全名を取得します。

なお，リリース状態「削除待ち」「リリース登録待ち」は一時的な状態のため，その状態のリリースIDを使用して各種メソッドを呼び出すと，参照に失敗するなどの不整合が発生することがあります。

3.3.1　getReleaseIDメソッド

(1)　説明

リリースIDを取得します。

(2)　形式

public java.lang.String getReleaseID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリースIDを1〜30バイトの文字列で返却します。

(6)　例外

なし。

3.3.2　getReleaseTimeメソッド

(1)　説明

リリース日時を取得します。

(2)　形式

public long getReleaseTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリース日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。情報がないユニットの場合は「-1」を返却します。

(6)　例外

なし。

3.3.3　getReleaseCommentメソッド

(1)　説明

リリースコメントを取得します。

(2)　形式

public java.lang.String getReleaseComment()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリースコメントを0〜80バイトの文字列で返却します。リリースコメントが設定されていない場合，および情報がないユニットの場合は，長さ0バイトの文字列を返却します。

(6)　例外

なし。

3.3.4　getReleaseStatusメソッド

(1)　説明

リリース状態を取得します。

(2)　形式

public ReleaseStatus getReleaseStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリース状態をReleaseStatusで返却します。

ReleaseStatusの詳細については，「付録A.12 (1)ReleaseStatus」を参照してください。

(6)　例外

なし。

3.3.5　getSourceUnitNameメソッド

(1)　説明

リリース元ジョブネット完全名を取得します。

(2)　形式

public java.lang.String getSourceUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リリース元ジョブネット完全名を1〜930バイトの文字列で返却します。情報がないユニットの場合は，長さ0バイトの文字列を返却します。

(6)　例外

なし。

3.4　起動条件クラス（AjsCdStartCondition）

起動条件クラス（AjsCdStartCondition）は，起動条件を設定するクラスです。

registerImmediateExecメソッドの引数に起動条件を指定する場合に使用します。

registerImmediateExecメソッドの詳細については，「2.3.4 registerImmediateExecメソッド」を参照してください。

起動条件クラスの詳細を次に示します。

クラス定義

public abstract class AjsCdStartCondition

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒4　起動条件クラス（AjsCdStartCondition）のメソッド一覧

メソッドの概要

public static AjsCdStartCondition

createAjsCdStartCondition()

起動条件クラス（AjsCdStartCondition）のインスタンスを生成します。

public void

setTimes(int times)

起動条件の有効範囲の回数を設定します。

public void

setPeriod(java.lang.String period)

起動条件の有効範囲の時間を設定します。

public void

setPeriodType(TimeType periodType)

起動条件の有効範囲の時間（setPeriodメソッドで設定）の種別を設定します。

public int

getTimes()

setTimesメソッドで設定した起動条件の有効範囲の回数を取得します。

public java.lang.String

getPeriod()

setPeriodメソッドで設定した起動条件の有効範囲の時間を取得します。

public TimeType

getPeriodType()

setPeriodTypeメソッドで設定した起動条件の有効範囲の時間の種別を取得します。

3.4.1　createAjsCdStartConditionメソッド

(1)　説明

起動条件クラス（AjsCdStartCondition）のインスタンスを生成します。

(2)　形式

public static AjsCdStartCondition createAjsCdStartCondition()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

起動条件クラス（AjsCdStartConditionクラス）のインスタンスを返却します。

(6)　例外

なし。

3.4.2　setTimesメソッド

(1)　説明

起動条件の有効範囲の回数を設定します。

メソッドを呼び出さなかった場合は，回数は「0（無制限）」となります。

(2)　形式

public void setTimes(int times)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

times

可

起動条件の有効範囲を回数で指定します。

回数は1〜999の範囲の数値を指定してください。「無制限」の場合は，「0」を指定してください。

(5)　戻り値

なし。

(6)　例外

なし。

3.4.3　setPeriodメソッド

(1)　説明

起動条件の有効範囲の時間を設定します。

setPeriodTypeメソッドで，時間種別に絶対時刻または相対時刻を設定した場合，必ず本メソッドで時間を設定してください。設定せずにAjsCdApiインターフェースのメソッドを呼び出した場合，例外を送出します。

(2)　形式

public void setPeriod(
　　java.lang.String period)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

period

不可

起動条件の有効範囲を時間で指定します。

setPeriodTypeメソッドで設定した時間種別「periodType」により，次に示すとおりに指定してください。

periodTypeが絶対時間の場合

「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。

指定する時刻は，要求先JP1/AJS3 - Managerが認識する時刻で指定してください。

periodTypeが相対時間の場合

相対時刻を「hhmm」形式で指定します（4文字固定）。

hhに指定できる値は，00〜47（単位：時）です。

mmに指定できる値は，00〜59（単位：分）です。ただし，0000は指定できません（1分〜47時間59分）。

periodTypeが無制限の場合

値は無視します。

(5)　戻り値

なし。

(6)　例外

なし。

3.4.4　setPeriodTypeメソッド

(1)　説明

起動条件の有効範囲の時間（setPeriodメソッドで設定）の種別を設定します。

メソッドを呼び出さなかった場合は，時間は「NO（無制限）」となります。

(2)　形式

public void setPeriodType(
　　TimeType periodType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

periodType

不可

setPeriodメソッドで設定した起動条件の有効範囲の時間の「種別」を指定します。メソッドを呼び出さなかった場合は，「無制限」となります。

指定できる値と内容については，「付録A.5 (1)TimeType」を参照してください

(5)　戻り値

なし。

(6)　例外

なし。

3.4.5　getTimesメソッド

(1)　説明

setTimesメソッドで設定した起動条件の有効範囲の回数を取得します。

(2)　形式

public int getTimes()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した起動条件の有効範囲の回数を返却します。設定していない場合は「0（無制限）」を返却します。

(6)　例外

なし。

3.4.6　getPeriodメソッド

(1)　説明

setPeriodメソッドで設定した起動条件の有効範囲の時間を取得します。

(2)　形式

public java.lang.String getPeriod()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した起動条件の有効範囲の時間を返却します。設定していない場合は「0（無制限）」を返却します。

(6)　例外

なし。

3.4.7　getPeriodTypeメソッド

(1)　説明

setPeriodTypeメソッドで設定した起動条件の有効範囲の時間の種別を取得します。

(2)　形式

public TimeType getPeriodType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した起動条件の有効範囲の時間の種別を返却します。設定していない場合は「NO（無制限）」を返却します。

(6)　例外

なし。

3.5　マクロ変数リストクラス（AjsCdMacroVariableList）

マクロ変数リストクラス（AjsCdMacroVariableList）は，マクロ変数情報を複数保持するクラスです。

AjsCdApiインターフェースのregisterImmediateExecメソッド，registerPlannedExecメソッド，registerFixedExecメソッド，およびaddExecScheduleメソッドの引数にマクロ変数を指定する場合に使用します。マクロ変数は32個まで指定できます。

各メソッドの詳細については，「2.3.4 registerImmediateExecメソッド」，「2.3.5 registerPlannedExecメソッド」，「2.3.6 registerFixedExecメソッド」，および「2.3.8 addExecScheduleメソッド」を参照してください。

複数指定した場合に指定できる文字数は，「マクロ変数名＋引き継ぎ情報＋4」の値が4,085バイト以内です。同一マクロ変数を指定した場合，最初に指定したマクロ変数の引き継ぎ情報が引き継がれます。

マクロ変数クラスの詳細を次に示します。

クラス定義

public abstract class AjsCdMacroVariableList

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒5　マクロ変数リストクラス（AjsCdMacroVariableList）のメソッド一覧

メソッドの概要

public static AjsCdMacroVariableList

createAjsCdMacroVariableList()

マクロ変数リストクラス（AjsCdMacroVariableList）のインスタンスを生成します。

public void

addMacroVariable(java.lang.String name,

java.lang.String value)

マクロ変数を追加，設定します。

public java.util.List<AjsCdMacroVariable>

getMacroVariableList()

設定済みマクロ変数の情報を，マクロ変数インターフェース（AjsCdMacroVariable）のリストで取得します。

3.5.1　createAjsCdMacroVariableListメソッド

(1)　説明

マクロ変数リストクラス（AjsCdMacroVariableList）のインスタンスを生成します。

(2)　形式

public static AjsCdMacroVariableList createAjsCdMacroVariableList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

マクロ変数リストクラス（AjsCdMacroVariableList）のインスタンスを返却します。

(6)　例外

なし。

3.5.2　addMacroVariableメソッド

(1)　説明

マクロ変数を追加，設定します。

(2)　形式

public void addMacroVariable(
　　java.lang.String name,
　　java.lang.String value)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

name

不可

マクロ変数名を文字列で指定します。

「AJS2xxxxx」（xxxxxは任意の文字列）の形式で指定します。前後の?は不要です。先頭は大文字で「AJS2」と指定する必要があります。

任意の文字列には，英大文字，数字，「.（ピリオド）」が指定できます。

指定できる文字数は，62バイト（64−前後の?の2バイト）以内です。

指定できない形式，文字が指定された場合は，AjsCdApiインターフェースのメソッドを呼び出した時点で，例外を送出します。

value

不可

引き継ぎ情報を文字列で指定します。

指定できる文字数は，0〜255（単位：バイト）です。

(5)　戻り値

なし。

(6)　例外

なし。

3.5.3　getMacroVariableListメソッド

(1)　説明

設定済みマクロ変数の情報を，マクロ変数インターフェース（AjsCdMacroVariable）のリストで取得します。

(2)　形式

public java.util.List<AjsCdMacroVariable> getMacroVariableList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

マクロ変数の情報をマクロ変数インターフェース（AjsCdMacroVariable）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

マクロ変数が１つも設定されていない場合は，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.6　マクロ変数インターフェース（AjsCdMacroVariable）

マクロ変数インターフェース（AjsCdMacroVariable）は，マクロ変数情報を１つ保持するクラスのインターフェースです。

インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetInheritResultメソッドで取得できます。

getInheritResultメソッドの詳細については，「2.3.23 getInheritResultメソッド」を参照してください。

マクロ変数インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdMacroVariable

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒6　マクロ変数インターフェース（AjsCdMacroVariable）のメソッド一覧

メソッドの概要

public java.lang.String

getName()

マクロ変数名を取得します。

public java.lang.String

getValue()

引き継ぎ結果を取得します。

3.6.1　getNameメソッド

(1)　説明

マクロ変数名を取得します。

(2)　形式

public java.lang.String getName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

マクロ変数名を5〜62バイトの文字列で返却します。接頭辞「AJS2」から始まる形式で返却します。

(6)　例外

なし。

3.6.2　getValueメソッド

(1)　説明

引き継ぎ結果を取得します。

(2)　形式

public java.lang.String getValue()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

引き継ぎ結果を0〜255バイトの文字列で返却します。引き継ぎ結果が存在しない場合は，空文字列を返却します。

(6)　例外

なし。

3.7　ユニット検索条件クラス（AjsCdSearchCondition）

ユニット検索条件クラス（AjsCdSearchCondition）は，ユニットを取得する条件情報を保持するクラスです。

AjsCdApiインターフェースのsearchUnitメソッドの引数に取得条件を指定する場合に使用します。searchUnitメソッドでは指定した取得条件をすべて満たすユニットの一覧が取得されます。

searchUnitメソッドの詳細については，「2.3.19 searchUnitメソッド」を参照してください。

ユニット検索条件クラスの詳細を次に示します。

クラス定義

public abstract class AjsCdSearchCondition

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒7　ユニット検索条件クラス（AjsCdSearchCondition）のメソッド一覧

メソッドの概要

public static AjsCdSearchCondition

createAjsCdSearchCondition()

ユニット検索条件クラス（AjsCdSearchCondition）のインスタンスを生成します。

public void

setSearchLocation(java.lang.String searchLocation)

取得したいユニットの上位ユニットの名称を設定します。

public void

setSearchLowerUnits(LowerType searchlower)

setSearchLocationメソッドで指定したユニットの，直下1階層のユニット情報を取得対象とするか，配下のユニットすべての情報を取得対象とするかを設定します。

public void

setSearchTarget(SearchTargetType searchTarget)

取得対象の範囲を設定します。

public void

setUnitName(java.lang.String unitName)

取得したいユニットの名称を設定します。

public void

setUnitNameMatchMethods(MatchMethods matchMethods)

ユニット名の比較方法を設定します。

public void

setExecID(java.lang.String execID)

取得したいユニットの実行IDを設定します。

public void

setUnitType(UnitType unitType)

取得したいユニットの種別を設定します。

public void

setGeneration(GenerationType generation)

取得したいユニットの世代を設定します。

public void

setPeriodBegin(java.lang.String begin)

期間を指定して対象世代を指定する場合の開始日時を設定します。

public void

setPeriodEnd(java.lang.String end)

期間を指定して対象世代を指定する場合の終了日時を設定します。

public void

setStatus(UnitStatus unitStatus)

取得したいユニットの状態を設定します。

public void

setDelayStatus(DelayStatus delayStatus)

取得したいユニットの遅延状態を設定します。

public void

setHoldAttr(HoldAttr holdAttr)

取得したいユニットの保留状態を設定します。

public void

setUnitComment(java.lang.String unitComment)

取得したいユニットのコメントを設定します。

public void

setUnitCommentMatchMethods(java.lang.String unitComment)

ユニットのコメントの比較方法を設定します。

public void

setExecHost(java.lang.String execHostName)

取得したいユニットの実行ホストを設定します。

public void

setExecHostMatchMethods(MatchMethods matchMethods)

ユニットの実行ホストの比較方法を設定します。

public void

setReleaseID(java.lang.String releaseID)

取得したいユニットのリリースIDを設定します。

public void

setReleaseInfoSearchMethods(ReleaseInfoSearchMethods release)

リリース情報の取得方法を設定します。

public void

setResultMax(MatchMethods matchMethods)

取得結果の最大数を設定します。

public java.lang.String

getSearchLocation()

setSearchLocationメソッドで設定したユニットの上位ユニットの名称を取得します。

public LowerType

getSearchLowerUnits()

setSearchLowerUnitsメソッドで設定した配下のユニットの取得対象を取得します。

public SearchTargetType

getSearchTarget()

setSearchTargetメソッドで設定した取得対象の範囲を取得します。

public java.lang.String

getUnitName()

setUnitNameメソッドで設定したユニットの名称を取得します。

public MatchMethods

getUnitNameMatchMethods()

setUnitNameMatchMethodsメソッドで設定したユニット名の比較方法を取得します。

public java.lang.String

getExecID()

setExecIDメソッドで設定したユニットの実行IDを取得します。

public UnitType

getUnitType()

setUnitTypeメソッドで設定したユニットの種別を取得します。

public GenerationType

getGeneration()

setGenerationメソッドで設定したユニットの世代を取得します。

public java.lang.String

getPeriodBegin()

setPeriodBeginメソッドで設定した期間指定の開始日時を取得します。

public java.lang.String

getPeriodEnd()

setPeriodEndメソッドで設定した期間指定の終了日時を取得します。

public UnitStatus

getStatus()

setStatusメソッドで設定したユニットの状態を取得します。

public DelayType

getDelayStatus()

setDelayStatusメソッドで設定したユニットの遅延状態を取得します。

public HoldAttr

getHoldAttr()

setHoldAttrメソッドで設定したユニットの保留状態を取得します。

public java.lang.String

getUnitComment()

setUnitCommentメソッドで設定したユニットのコメントを取得します。

public MatchMethods

getUnitCommentMatchMethods()

setUnitCommentMatchMethodsメソッドで設定したコメントの比較方法を取得します。

public java.lang.String

getExecHost()

setExecHostメソッドで設定したユニットの実行ホストを取得します。

public MatchMethods

getExecHostMatchMethods()

setExecHostMatchMethodsメソッドで設定したユニットの実行ホストの比較方法を取得します。

public int

getResultMax()

setResultMaxメソッドで設定した取得結果の最大数を取得します。

public java.lang.String

getReleaseID()

setReleaseIDメソッドで設定したユニットのリリースIDを取得します。

public ReleaseInfoSearchMethods

getReleaseInfoSearchMethods()

setReleaseInfoSearchMethodsメソッドで設定したリリース情報の取得方法を設定します。

3.7.1　createAjsCdSearchConditionメソッド

(1)　説明

ユニット検索条件クラス（AjsCdSearchCondition）のインスタンスを生成します。

(2)　形式

public static AjsCdSearchCondition createAjsCdSearchCondition()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット検索条件クラス（AjsCdSearchCondition）のインスタンスを返却します。

(6)　例外

なし。

3.7.2　setSearchLocationメソッド

(1)　説明

取得したいユニットの上位ユニットの名称を設定します。

本メソッドでユニットの名称を必ず設定してください。設定せずにsearchUnitメソッドを呼び出した場合，searchUnitメソッドは例外を送出します。

(2)　形式

public void setSearchLocation(java.lang.String searchLocation)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

searchLocation

不可

取得したいユニットの上位ユニット（ジョブグループまたはジョブネット）の完全名を，1〜930バイトの文字列

で指定します。

なお，次の文字は指定できません。

；（セミコロン）

＝

（

）

半角スペース

タブ文字

改行文字

(5)　戻り値

なし。

(6)　例外

なし。

3.7.3　setSearchLowerUnitsメソッド

(1)　説明

setSearchLocationメソッドで指定したユニットの，直下１階層のユニット情報を取得対象とするか，配下のユニットすべての情報を取得対象とするかを設定します。

メソッドを呼び出さなかった場合は，取得対象は「直下１階層のユニット」（デフォルト）となります。

(2)　形式

public void setSearchLowerUnits(LowerType searchlower)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

searchlower

不可

直下１階層のユニット情報を取得対象とするか，配下のユニットすべての情報を取得対象とするかを定数で指定します。

指定できる値と内容については，「付録A.6 (1)LowerType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「直下１階層のユニット」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.4　setSearchTargetメソッド

(1)　説明

取得対象の範囲を設定します。

メソッドを呼び出さなかった場合は，「DEFINITION_AND_STATUS（定義と状態）」（デフォルト）となります。

(2)　形式

public void setSearchTarget(SearchTargetType searchTarget)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

searchTarget

不可

取得対象の範囲を指定します。

ユニットの定義だけを取得対象とするか，ユニットの実行状態や世代数などを考慮して，ユニットの定義および状態を取得対象とするかを設定します。

指定できる値と内容については，「付録A.6 (8)SearchTargetType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「DEFINITION_AND_STATUS（定義と状態）」となります。

なお，「DEFINITION（定義）」を指定した場合は，次のユニット状態に関する設定は無視されます。

実行ID：setExecIDメソッドによる設定

世代：setGenerationメソッドによる設定

期間の開始日時：setPeriodBeginメソッドによる設定

期間の終了日時：setPeriodEndメソッドによる設定

状態：setStatusメソッドによる設定

遅延状態：setDelayStatusメソッドによる設定

保留状態：setHoldAttrメソッドによる設定

実行ホスト：setExecHostメソッドによる設定

実行ホストの比較方法： setExecHostMatchMethodsメソッドによる設定

(5)　戻り値

なし。

(6)　例外

なし。

3.7.5　setUnitNameメソッド

(1)　説明

取得したいユニットの名称を設定します。

setUnitNameMatchMethodsメソッドで検索条件を指定した場合だけ設定します。

(2)　形式

public void setUnitName(java.lang.String unitName)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

unitName

不可

情報取得対象のユニット名を，1〜30バイトの文字列で指定します。

比較方法はsetUnitNameMatchMethodsメソッドで設定します。

「RE（正規表現）」を使用する場合は1〜64バイトの文字列で指定します。

「NO（検索条件にしない）」を指定した場合は本設定は無視します。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.6　setUnitNameMatchMethodsメソッド

(1)　説明

ユニット名の比較方法を設定します。

メソッドを呼び出さなかった場合は，「NO（検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setUnitNameMatchMethods(MatchMethods matchMethods)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

matchMethods

不可

ユニット名の比較方法を設定します。

指定できる値と内容については，「付録A.6 (7)MatchMethods」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。検索条件にしない場合，すべてのユニット名が取得対象となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.7　setExecIDメソッド

(1)　説明

取得したいユニットの実行IDを設定します。

setGenerationメソッドで「EXECID（指定した実行IDの世代を取得）」を指定した場合にだけ設定します。

(2)　形式

public void setExecID(java.lang.String execID)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

execID

不可

実行IDを，文字列で指定します。

setGenerationメソッドで「EXECID（指定した実行IDの世代を取得）」を指定した場合にだけ有効です。その他の指定では無視します。

指定する形式は「@［mmmm］｛A〜Z｝nnnn」です。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.8　setUnitTypeメソッド

(1)　説明

取得したいユニットの種別を設定します。

メソッドを呼び出さなかった場合は，「NO（検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setUnitType(UnitType unitType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

unitType

不可

どの種別のユニットを対象にするかを指定します。

指定できる値と内容については，「付録A.6 (2)UnitType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。

検索条件にしない場合，すべてのユニット種別が取得対象となります。

なお，ジョブグループなどの「GROUP」を指定した場合は，次のユニット定義または状態に関する設定は無視されます。

［定義］

リリースID：setReleaseIDメソッドによる設定

リリース情報の取得方法：setReleaseInfoSearchMethodsメソッドによる設定

［状態］

実行ID：setExecIDメソッドによる設定

世代：setGenerationメソッドによる設定

期間の開始日時：setPeriodBeginメソッドによる設定

期間の終了日時：setPeriodEndメソッドによる設定

状態：setStatusメソッドによる設定

遅延状態：setDelayStatusメソッドによる設定

保留状態：setHoldAttrメソッドによる設定

実行ホスト：setExecHostメソッドによる設定

実行ホストの比較方法： setExecHostMatchMethodsメソッドによる設定

また，ルートジョブネットなどの「ROOT」，およびジョブネットなどの「NET」を指定した場合は，次のユニット状態に関する設定は無視されます。

実行ホスト：setExecHostメソッドによる設定

実行ホストの比較方法：setExecHostMatchMethodsメソッドによる設定

(5)　戻り値

なし。

(6)　例外

なし。

3.7.9　setGenerationメソッド

(1)　説明

取得したいユニットの世代を設定します。

メソッドを呼び出さなかった場合は，「STATUS（最新状態）」（デフォルト）を取得します。

(2)　形式

public void setGeneration(GenerationType generation)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

generation

不可

どの世代の情報を取得するかを指定します。

指定できる値と内容は「付録A.6 (3)GenerationType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「STATUS（最新状態）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.10　setPeriodBeginメソッド

(1)　説明

期間を指定して対象世代を指定する場合の開始日時を設定します。

指定した期間の終了日時はsetPeriodEndメソッドで設定します。

setGenerationメソッドで検索方法に「期間指定」を設定していない場合，このメソッドで指定された条件は無視されます。

searchUnitメソッドでこの条件を指定すると，ルートジョブネットの開始日時から終了日時が指定した期間に一部でも重なる世代が検索されます。

「期間指定」の検索でヒットする世代の詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」の検索ウィンドウの検索条件について記載している個所を参照してください。

(2)　形式

public void setPeriodBegin(java.lang.String begin)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

begin

不可

開始日時を指定します。

setPeriodEndメソッドで指定する終了日時より以前の日時を指定してください。

「YYYYMMDDhhmm」形式の文字列で指定します（12文字固定）。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜選択した月の最終日（単位：日）です。

hh：時間を指定します。時間に指定できる値は00〜23（単位：時）です。

mm：分を指定します。分に指定できる値は00〜59（単位：分）です。

指定した日時以降に存在する世代を取得対象とします。

日時を次のように指定した場合は，searchUnitメソッド実行時に例外クラス（AjsCdException）を送出します。

日時に指定された値が形式不正の場合。

指定できる範囲外の値を指定した場合。

開始日時に終了日時よりあとの日時を指定した場合。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.11　setPeriodEndメソッド

(1)　説明

期間を指定して対象世代を指定する場合の終了日時を設定します。

期間の開始日時はsetPeriodBeginメソッドで設定します。

setGenerationメソッドで検索方法に「PERIOD（期間指定）」を設定していない場合，このメソッドで指定された条件は無視されます。

(2)　形式

public void setPeriodEnd(java.lang.String end)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

end

不可

終了日時を指定します。

setPeriodBeginメソッドで指定した開始日時以降の日時を指定してください。

「YYYYMMDDhhmm」形式の文字列で指定します（12文字固定）。

YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。

MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

DD：日にちを指定します。日にちに指定できる値は，01〜選択した月の最終日（単位：日）です。

hh：時間を指定します。時間に指定できる値は00〜23（単位：時）です。

mm：分を指定します。分に指定できる値は00〜59（単位：分）です。

指定した日時以前に存在する世代を取得対象とします。

日時を次のように指定した場合は，searchUnitメソッド実行時に例外クラス（AjsCdException）を送出します。

日時に指定された値が形式不正の場合。

指定できる範囲外の値を指定した場合。

終了日時に開始日時により前の日時を指定した場合。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.12　setStatusメソッド

(1)　説明

取得したいユニットの状態を設定します。

メソッドを呼び出さなかった場合は，すべてのユニットの状態が取得対象となります。

(2)　形式

public void setStatus(UnitStatus unitStatus)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

unitStatus

不可

取得したいユニットの状態を定数で指定します。

指定できる値と内容については，「付録A.6 (4)UnitStatus」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。検索条件にしない場合，すべてのユニットの状態が取得対象となります。

なお，「UNREGISTERED（未登録）」を指定した場合は，以下のユニット状態に関する設定は無視します。

実行ID：setExecIDメソッドによる設定

世代：setGenerationメソッドによる設定

期間の開始日時：setPeriodBeginメソッドによる設定

期間の終了日時：setPeriodEndメソッドによる設定

遅延状態：setDelayStatusメソッドによる設定

保留状態：setHoldAttrメソッドによる設定

実行ホスト：setExecHostメソッドによる設定

実行ホストの比較方法：setExecHostMatchMethodsメソッドによる設定

また，「UNREGISTERED（未登録）」を指定した場合で，ジョブネットリリース機能を使用している場合に，同一ユニット名のユニット情報が複数取得されることがあります。この場合，同一ユニット名のユニット情報は無視してください。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.13　setDelayStatusメソッド

(1)　説明

取得したいユニットの遅延状態を設定します。

メソッドを呼び出さなかった場合は，「NO（遅延を検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setDelayStatus(DelayType delayStatus)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

delayStatus

不可

取得したいユニットの遅延状態を定数で指定します。

指定できる値と内容については，「付録A.6 (5)DelayType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（遅延を検索条件にしない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.14　setHoldAttrメソッド

(1)　説明

取得したいユニットの保留状態を設定します。

メソッドを呼び出さなかった場合は，「NO（保留予定を検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setHoldAttr(HoldAttr holdAttr)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

holdAttr

不可

取得したいユニットの保留状態を定数で指定します。

指定できる値と内容については，「付録A.6 (6)HoldAttr」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（保留予定を検索条件にしない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

(7)　注意事項

ユニットの保留状態を設定した場合は，待ち状態の世代だけでなく，保留中の世代，および実行が終了した世代も検索対象になります。実行が終了した世代も検索対象になるため，再実行した場合に保留される世代についても検索できます。

待ち状態の世代だけ，実行が終了した世代だけ，または特定の世代だけを検索対象にしたい場合は，setGenerationメソッドやsetStatusメソッドで同時に設定して，検索対象の世代を特定して検索してください。

3.7.15　setUnitCommentメソッド

(1)　説明

取得したいユニットのコメントを設定します。

setUnitCommentMatchMethodsメソッドで検索条件を指定した場合にだけ設定します。

(2)　形式

public void setUnitComment(java.lang.String unitComment)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

unitComment

不可

取得したいユニットのコメントを文字列で指定します。

比較方法はsetUnitCommentMatchMethodsメソッドで設定します。

「NO（検索条件にしない）」を指定した場合は本設定を無視します。

比較方法に「EQ（完全一致）」を設定して，空文字列（0バイト）が指定された場合は，コメントが定義されていないユニットが取得対象となります。

設定できるコメントのバイト数は，比較方法ごとに異なります。

EQ：0〜80

BW：1〜80

EW：1〜80

NE：0〜80

CO：1〜80

NC：1〜80

RE：1〜164

(5)　戻り値

なし。

(6)　例外

なし。

3.7.16　setUnitCommentMatchMethodsメソッド

(1)　説明

ユニットのコメントの比較方法を設定します。

メソッドを呼び出さなかった場合は，「NO（検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setUnitCommentMatchMethods(MatchMethods matchMethods)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

matchMethods

不可

ユニットのコメントの比較方法を設定します。

指定できる値と内容については，「付録A.6 (7)MatchMethods」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.17　setExecHostメソッド

(1)　説明

取得したいユニットの実行ホスト※を設定します。

setExecHostMatchMethodsメソッドで検索条件を指定した場合にだけ設定します。

注※　ユニット定義の「実行エージェント」ではなく，実際に実行されたJP1/AJS3 - Agentホスト名です。

(2)　形式

public void setExecHost(java.lang.String execHostName)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

execHostName

不可

取得したいユニットの実行ホスト名を文字列で指定します。

比較方法はsetExecHostMatchMethodsメソッドで設定します。

「NO（検索対象にしない）」を指定した場合は本設定を無視します。

比較方法に「EQ（完全一致）」を設定して，空文字列（0バイト）が指定された場合は，実行ホストが確定していない待ち状態のジョブが検索対象になります。

設定できる実行ホスト名のバイト数は，比較方法ごとに異なります。

EQ：0〜255

BW：1〜255

EW：1〜255

NE：0〜255

CO：1〜255

NC：1〜255

RE：1〜514

(5)　戻り値

なし。

(6)　例外

なし。

3.7.18　setExecHostMatchMethodsメソッド

(1)　説明

ユニットの実行ホストの比較方法を設定します。

メソッドを呼び出さなかった場合は，「NO（検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setExecHostMatchMethods(MatchMethods matchMethods)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

matchMethods

不可

ユニットの実行ホスト名の比較方法を指定します。

指定できる値と内容については，「付録A.6 (7)MatchMethods」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.19　setReleaseIDメソッド

(1)　説明

取得したいユニットのリリースIDを設定します。

setReleaseInfoSearchMethodsメソッドで「ID（リリースID）」を指定した場合にだけ設定します。

(2)　形式

public void setReleaseID(java.lang.String releaseID)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

releaseID

不可

取得したいユニットのリリースIDを1〜30バイトの文字列で指定します。

リリース情報の取得方法はsetReleaseInfoSearchMethodsメソッドで設定します。

setReleaseInfoSearchMethodsメソッドで「ID（リリースID）」を指定した場合にだけ設定します。その他の指定では無視されます。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.20　setReleaseInfoSearchMethodsメソッド

(1)　説明

リリース情報の取得方法を設定します。

メソッドを呼び出さなかった場合は，「NO（検索条件にしない）」（デフォルト）となります。

(2)　形式

public void setReleaseInfoSearchMethods(ReleaseInfoSearchMethods release)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

release

不可

リリース情報の取得方法を設定します。

指定できる値と内容については，「付録A.6 (9)ReleaseInfoSearchMethods」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「NO（検索条件にしない）」となります。検索条件にしない場合，すべてのリリース情報が取得対象となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.21　setResultMaxメソッド

(1)　説明

取得結果の最大数を設定します。

メソッドを呼び出さなかった場合は，「0（環境設定ファイルの「api_search_resultmax」に従う）」（デフォルト）となります。

(2)　形式

public void setResultMax(int resultMax)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

resultMax

不可

取得結果の最大数を0，または1〜2147483646で設定します。0を指定した場合，環境設定ファイルの「api_search_resultmax」の設定に従います。

デフォルト（メソッドを呼び出さなかった場合）は，「0」となります。

環境設定ファイルの詳細については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」を参照してください。

(5)　戻り値

なし。

(6)　例外

なし。

3.7.22　getSearchLocationメソッド

(1)　説明

setSearchLocationメソッドで設定したユニットの上位ユニットの名称を取得します。

(2)　形式

public java.lang.String getSearchLocation()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

上位ユニットの名称を返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.23　getSearchLowerUnitsメソッド

(1)　説明

setSearchLowerUnitsメソッドで設定した配下のユニットの取得対象を取得します。

(2)　形式

public LowerType getSearchLowerUnits()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

配下のユニットの取得対象を返却します。設定していない場合は「NO（直下１階層のユニットが取得対象）」を返却します。

(6)　例外

なし。

3.7.24　getSearchTargetメソッド

(1)　説明

setSearchTargetメソッドで設定した取得対象の範囲を取得します。

(2)　形式

public SearchTargetType getSearchTarget()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した取得対象の範囲を返却します。設定していない場合は「DEFINITION_AND_STATUS（定義と状態）」を返却します。

(6)　例外

なし。

3.7.25　getUnitNameメソッド

(1)　説明

setUnitNameメソッドで設定したユニットの名称を取得します。

(2)　形式

public java.lang.String getUnitName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの名称を返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.26　getUnitNameMatchMethodsメソッド

(1)　説明

setUnitNameMatchMethodsメソッドで設定したユニット名の比較方法を取得します。

(2)　形式

public MatchMethods getUnitNameMatchMethods()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット名の比較方法を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.27　getExecIDメソッド

(1)　説明

setExecIDメソッドで設定したユニットの実行IDを取得します。

(2)　形式

public java.lang.String getExecID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの実行IDを返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.28　getUnitTypeメソッド

(1)　説明

setUnitTypeメソッドで設定したユニットの種別を取得します。

(2)　形式

public UnitType getUnitType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの種別を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.29　getGenerationメソッド

(1)　説明

setGenerationメソッドで設定したユニットの世代を取得します。

(2)　形式

public GenerationType getGeneration()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの世代を返却します。設定していない場合は「STATUS（最新状態）」を返却します。

(6)　例外

なし。

3.7.30　getPeriodBeginメソッド

(1)　説明

setPeriodBeginメソッドで設定した期間指定の開始日時を取得します。

(2)　形式

public java.lang.String getPeriodBegin()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

期間指定の開始日時を返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.31　getPeriodEndメソッド

(1)　説明

setPeriodEndメソッドで設定した期間指定の終了日時を取得します。

(2)　形式

public java.lang.String getPeriodEnd()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

期間指定の終了日時を返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.32　getStatusメソッド

(1)　説明

setStatusメソッドで設定したユニットの状態を取得します。

(2)　形式

public UnitStatus getStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの状態を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.33　getDelayStatusメソッド

(1)　説明

setDelayStatusメソッドで設定したユニットの遅延状態を取得します。

(2)　形式

public DelayType getDelayStatus()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの遅延状態を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.34　getHoldAttrメソッド

(1)　説明

setHoldAttrメソッドで設定したユニットの保留状態を取得します。

(2)　形式

public HoldAttr getHoldAttr()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの保留状態を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.35　getUnitCommentメソッド

(1)　説明

setUnitCommentメソッドで設定したユニットのコメントを取得します。

(2)　形式

public java.lang.String getUnitComment()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットのコメントを返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.36　getUnitCommentMatchMethodsメソッド

(1)　説明

setUnitCommentMatchMethodsメソッドで設定したコメントの比較方法を取得します。

(2)　形式

public MatchMethods getUnitCommentMatchMethods()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

コメントの比較方法を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.37　getExecHostメソッド

(1)　説明

setExecHostメソッドで設定したユニットの実行ホストを取得します。

(2)　形式

public java.lang.String getExecHost()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの実行ホストを返却します。設定していない場合は空文字列を返却します。

(6)　例外

なし。

3.7.38　getExecHostMatchMethodsメソッド

(1)　説明

setExecHostMatchMethodsメソッドで設定したユニットの実行ホストの比較方法を取得します。

(2)　形式

public MatchMethods getExecHostMatchMethods()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの実行ホストの比較方法を返却します。設定していない場合は「NO（検索条件にしない）」を返却します。

(6)　例外

なし。

3.7.39　getResultMaxメソッド

(1)　説明

setResultMaxメソッドで設定した取得結果の最大数を取得します。

(2)　形式

public int getResultMax()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

取得結果の最大数を返却します。設定していない場合は「0」を返却します。

(6)　例外

なし。

3.7.40　getReleaseIDメソッド

(1)　説明

setReleaseIDメソッドで設定したユニットのリリースIDを取得します。

(2)　形式

public java.lang.String getReleaseID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定したユニットのリリースIDを返却します。設定していない場合は長さ0バイトの文字列を返却します。

(6)　例外

なし。

3.7.41　getReleaseInfoSearchMethodsメソッド

(1)　説明

setReleaseInfoSearchMethodsメソッドで設定したリリース情報の取得方法を取得します。

(2)　形式

public ReleaseInfoSearchMethods getReleaseInfoSearchMethods()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定したリリース情報の取得方法を返却します。設定していない場合は「NO（検索対象にしない）」を返却します。

(6)　例外

なし。

3.8　ユニット検索結果インターフェース（AjsCdSearchResult）

ユニット検索結果インターフェース（AjsCdSearchResult）は，ユニットの検索結果を保持するインターフェースです。

ユニット検索結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのsearchUnitメソッドで取得できます。

searchUnitメソッドの詳細については，「2.3.19 searchUnitメソッド」を参照してください。

ユニット検索結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdSearchResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒8　ユニット検索結果インターフェース（AjsCdSearchResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdUnitInfo>

getUnitInfo()

検索結果をユニット情報インターフェース（AjsCdUnitInfo）のリストで取得します。

public boolean

isAll()

すべての検索を取得できたかどうかを取得します。

3.8.1　getUnitInfoメソッド

(1)　説明

検索結果をユニット情報インターフェース（AjsCdUnitInfo）のリストで取得します。

(2)　形式

public java.util.List<AjsCdUnitInfo> getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット情報インターフェース（AjsCdUnitInfo）のListを返却します。

該当するユニットが存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.8.2　isAllメソッド

(1)　説明

すべての結果を取得できたかどうかを取得します。

(2)　形式

public boolean isAll()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

すべての結果を取得できた場合，「true」を返却します。すべての結果を取得できなかった場合，「false」を返却します。

なお，取得結果の上限数は，ユニット検索条件クラス（AjsCdSearchCondition）のsetResultMaxメソッドで設定できます。

setResultMaxメソッドの詳細については，「3.7.21 setResultMaxメソッド」を参照してください。

また，取得結果の上限数は，JP1/AJS3 - SDKの環境設定ファイルでも変更できます。デフォルト値は1,000です。環境設定ファイルの詳細については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」を参照してください。

(6)　例外

なし。

3.9　ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）は，ジョブグループ直下のユニットを取得するオプションを保持するクラスです。

ジョブグループ直下ユニット取得オプションクラスは，AjsCdApiインターフェースのgetCurrentStatusesUnderJobGroupメソッドの取得オプションの指定に使用します。

getCurrentStatusesUnderJobGroupメソッドの詳細については，「2.3.24 getCurrentStatusesUnderJobGroupメソッド」を参照してください。

ジョブグループ直下ユニット取得オプションクラスの詳細を次に示します。

クラス定義

public abstract class AjsCdGetCurrentStatusesUnderJobGroupOption

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒9　ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）のメソッド一覧

メソッドの概要

public static AjsCdGetCurrentStatusesUnderJobGroupOption

createAjsCdGetCurrentStatusesUnderJobGroupOption()

AjsCdGetCurrentStatusesUnderJobGroupOptionクラスのインスタンスを生成します。

public void

setGetHoldPlanType(GetHoldPlanType holdPlanType)

「保留予定の有無を取得するかどうか」を設定します。

public void

setStatusItem(AjsCdGetStatusDetailOption statusItem)

「最新状態情報で取得する情報」を設定します。

public void

setResultItem(AjsCdGetStatusDetailOption resultItem)

「最新結果情報で取得する情報」を設定します。

public GetHoldPlanType

getGetHoldPlanType()

「保留予定の有無を取得するかどうか」を取得します。

public AjsCdGetStatusDetailOption

getStatusItem()

「最新状態情報で取得する情報」を取得します。

public AjsCdGetStatusDetailOption

getResultItem()

「最新結果情報で取得する情報」を取得します。

3.9.1　createAjsCdGetCurrentStatusesUnderJobGroupOptionメソッド

(1)　説明

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）のインスタンスを生成します。

(2)　形式

public static AjsCdGetCurrentStatusesUnderJobGroupOption createAjsCdGetCurrentStatusesUnderJobGroupOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）のインスタンスを返却します。

(6)　例外

なし。

3.9.2　setGetHoldPlanTypeメソッド

(1)　説明

「保留予定の有無を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「HOLDPLAN_NO（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetHoldPlanType(GetHoldPlanType holdPlanType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

holdPlanType

不可

「保留予定の有無を取得するかどうか」を設定します。

指定できる値と内容については，「付録A.9 (1)GetHoldPlanType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「HOLDPLAN_NO（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.9.3　setStatusItemメソッド

(1)　説明

「最新状態情報で取得する情報」を設定します。

メソッドを呼び出さなかった場合は，「取得しない」（デフォルト）となります。

(2)　形式

public void setStatusItem(AjsCdGetStatusDetailOption statusItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

statusItem

不可

取得する情報を指定した，取得項目オプションクラス（AjsCdGetStatusDetailOption）を指定します。

取得項目オプションクラスの詳細については，「3.10 取得項目オプションクラス（AjsCdGetStatusDetailOption）」を参照してください。

(5)　戻り値

なし。

(6)　例外

なし。

3.9.4　setResultItemメソッド

(1)　説明

「最新結果情報で取得する情報」を設定します。

メソッドを呼び出さなかった場合は，「取得しない」（デフォルト）となります。

(2)　形式

public void setResultItem(AjsCdGetStatusDetailOption resultItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

resultItem

不可

取得する情報を指定した，取得項目オプションクラス（AjsCdGetStatusDetailOption）を指定します。

取得項目オプションクラスの詳細については，「3.10 取得項目オプションクラス（AjsCdGetStatusDetailOption）」を参照してください。

(5)　戻り値

なし。

(6)　例外

なし。

3.9.5　getGetHoldPlanTypeメソッド

(1)　説明

setGetHoldPlanTypeメソッドで設定した「保留予定の有無を取得するかどうか」を取得します。

(2)　形式

public GetHoldPlanType getGetHoldPlanType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「保留予定の有無を取得するかどうか」を返却します。設定していない場合は「HOLDPLAN_NO（取得しない）」を返却します。

(6)　例外

なし。

3.9.6　getStatusItemメソッド

(1)　説明

setStatusItemメソッドで設定した「最新状態情報で取得する情報」を取得します。

(2)　形式

public AjsCdGetStatusDetailOption getStatusItem()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを返却します。

設定していない場合は，デフォルト値を保持する取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを返却します。

(6)　例外

なし。

3.9.7　getResultItemメソッド

(1)　説明

setResultItemメソッドで設定した「最新結果情報で取得する情報」を取得します。

(2)　形式

public AjsCdGetStatusDetailOption getResultItem()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを返却します。

設定していない場合は，デフォルト値を保持する取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを返却します。

(6)　例外

なし。

3.10　取得項目オプションクラス（AjsCdGetStatusDetailOption）

取得項目オプションクラス（AjsCdGetStatusDetailOption）は，取得する項目を保持するクラスです。

取得項目オプションクラスは，ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）のsetStatusItemメソッドおよびsetResultItemメソッドの指定に使用します。

setStatusItemメソッドの詳細については，「3.9.3 setStatusItemメソッド」，setResultItemメソッドの詳細については，「3.9.4 setResultItemメソッド」を参照してください。

取得項目オプションクラスの詳細を次に示します。

クラス定義

public abstract class AjsCdGetStatusDetailOption

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒10　取得項目オプションクラス（AjsCdGetStatusDetailOption）のメソッド一覧

メソッドの概要

public static AjsCdGetStatusDetailOption

createAjsCdGetStatusDetailOption()

AjsCdGetStatusDetailOptionクラスのインスタンスを生成します。

public void

setGetStartTimeOption(boolean getItem)

「開始日時を取得するかどうか」を設定します。

public void

setGetEndTimeOption(boolean getItem)

「終了日時を取得するかどうか」を設定します。

public void

setGetChangeTypeOption(boolean getItem)

「計画一時変更の有無を取得するかどうか」を設定します。

public void

setGetStartDelayOption(boolean getItem)

「開始遅延日時を取得するかどうか」を設定します。

public void

setGetEndDelayOption(boolean getItem)

「終了遅延日時を取得するかどうか」を設定します。

public void

setGetExecutionTypeOption(boolean getItem)

「登録種別を取得するかどうか」を設定します。

public void

setGetStartConditionOption(boolean getItem)

「起動条件の情報を取得するかどうか」を設定します。

public boolean

isGetStartTimeOption()

「開始日時を取得するかどうか」を取得します。

public boolean

isGetEndTimeOption()

「終了日時を取得するかどうか」を取得します。

public boolean

isGetChangeTypeOption()

「計画一時変更の有無を取得するかどうか」を取得します。

public boolean

isGetStartDelayOption()

「開始遅延日時を取得するかどうか」を取得します。

public boolean

isGetEndDelayOption()

「終了遅延日時を取得するかどうか」を取得します。

public boolean

isGetExecutionTypeOption()

「登録種別を取得するかどうか」を取得します。

public boolean

isGetStartConditionOption()

「起動条件の情報を取得するかどうか」を取得します。

3.10.1　createAjsCdGetStatusDetailOptionメソッド

(1)　説明

取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを生成します。

(2)　形式

public static AjsCdGetStatusDetailOption createAjsCdGetStatusDetailOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

取得項目オプションクラス（AjsCdGetStatusDetailOption）のインスタンスを返却します。

(6)　例外

なし。

3.10.2　setGetStartTimeOptionメソッド

(1)　説明

「開始日時を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetStartTimeOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

開始予定日時，開始日時，および再実行開始日時を取得するかどうかを設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.3　setGetEndTimeOptionメソッド

(1)　説明

「終了日時を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetEndTimeOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「終了日時を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.4　setGetChangeTypeOptionメソッド

(1)　説明

「計画一時変更の有無を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetChangeTypeOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「計画一時変更の有無を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.5　setGetStartDelayOptionメソッド

(1)　説明

「開始遅延日時を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetStartDelayOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「開始遅延日時を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.6　setGetEndDelayOptionメソッド

(1)　説明

「終了遅延日時を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetEndDelayOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「終了遅延日時を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.7　setGetExecutionTypeOptionメソッド

(1)　説明

「登録種別を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetExecutionTypeOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「登録種別を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.8　setGetStartConditionOptionメソッド

(1)　説明

「起動条件の情報を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetStartConditionOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

次の「起動条件の情報を取得するかどうか」を設定します。

起動条件の有効範囲の回数

起動条件の有効範囲の時間

起動条件の有効範囲の時間の種別

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.10.9　isGetStartTimeOptionメソッド

(1)　説明

setGetStartTimeOptionメソッドで設定した「開始日時を取得するかどうか」を取得します。

(2)　形式

public boolean isGetStartTimeOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「開始日時を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.10　isGetEndTimeOptionメソッド

(1)　説明

setGetEndTimeOptionメソッドで設定した「終了日時を取得するかどうか」を取得します。

(2)　形式

public boolean isGetEndTimeOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「終了日時を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.11　isGetChangeTypeOptionメソッド

(1)　説明

setGetChangeTypeOptionメソッドで設定した「計画一時変更の有無を取得するかどうか」を取得します。

(2)　形式

public boolean isGetChangeTypeOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「計画一時変更の有無を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.12　isGetStartDelayOptionメソッド

(1)　説明

setGetStartDelayOptionメソッドで設定した「開始遅延日時を取得するかどうか」を取得します。

(2)　形式

public boolean isGetStartDelayOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「開始遅延日時を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.13　isGetEndDelayOptionメソッド

(1)　説明

setGetEndDelayOptionメソッドで設定した「終了遅延日時を取得するかどうか」を取得します。

(2)　形式

public boolean isGetEndDelayOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「終了遅延日時を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.14　isGetExecutionTypeOptionメソッド

(1)　説明

setGetExecutionTypeOptionメソッドで設定した「登録種別を取得するかどうか」を取得します。

(2)　形式

public boolean isGetExecutionTypeOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「登録種別を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.10.15　isGetStartConditionOptionメソッド

(1)　説明

setGetStartConditionOptionメソッドで設定した「起動条件の情報を取得するかどうか」を取得します。

(2)　形式

public boolean isGetStartConditionOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「起動条件の情報を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.11　ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）は，ジョブグループ直下ユニット取得の結果を保持するインターフェースです。

ジョブグループ直下ユニット取得結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetCurrentStatusesUnderJobGroupメソッドで取得できます。

getCurrentStatusesUnderJobGroupメソッドの詳細については，「2.3.24 getCurrentStatusesUnderJobGroupメソッド」を参照してください。

ジョブグループ直下ユニット取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdGetCurrentStatusesUnderJobGroupResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒11　ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdCurrentStatusesUnderJobGroup>

getCurrentStatusesUnderJobGroup()

ユニットの定義情報，最新状態情報および最新結果情報を取得します。

3.11.1　getCurrentStatusesUnderJobGroupメソッド

(1)　説明

ユニットの定義情報，最新状態情報，および最新結果情報を取得します。

(2)　形式

public java.util.List<AjsCdCurrentStatusesUnderJobGroup> getCurrentStatusesUnderJobGroup()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの定義情報，最新状態情報，および最新結果情報を，ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

該当するユニットが存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.12　ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）は，ユニットの定義情報，最新状態情報，および最新結果情報を保持するインターフェースです。

ジョブグループ直下ユニット情報インターフェースを実装したクラスのインスタンスは，ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）のgetCurrentStatusesUnderJobGroupメソッドで取得できます。

getCurrentStatusesUnderJobGroupメソッドの詳細については，「3.11.1 getCurrentStatusesUnderJobGroupメソッド」を参照してください。

ジョブグループ直下ユニット情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdCurrentStatusesUnderJobGroup

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒12　ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）のメソッド一覧

メソッドの概要

public AjsCdUnitInfo

getUnitInfo()

ユニットの定義情報を取得します。

public AjsCdUnitStatus

getStatusInfo()

ユニットの最新状態の詳細情報を取得します。

public AjsCdUnitStatus

getResultInfo()

ユニットの最新結果の詳細情報を取得します。

3.12.1　getUnitInfoメソッド

(1)　説明

ユニットの定義情報を取得します。

(2)　形式

public AjsCdUnitInfo getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの定義情報を，ユニット情報インターフェース（AjsCdUnitInfo）を実装したクラスのインスタンスとして返却します。

(6)　例外

なし。

3.12.2　getStatusInfoメソッド

(1)　説明

ユニットの最新状態の詳細情報を取得します。

(2)　形式

public AjsCdUnitStatus getStatusInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの最新状態の詳細情報を，ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）を実装したクラスのインスタンスとして返却します。

要求先JP1/AJS3 - Managerの環境設定パラメーター「VIEWSTATUSRANGE」の設定値によっては，getResultInfoメソッドと同じ情報が返却される場合があります。

取得する情報がない場合は，nullを返却します。

(6)　例外

なし。

3.12.3　getResultInfoメソッド

(1)　説明

ユニットの最新結果の詳細情報を取得します。

(2)　形式

public AjsCdUnitStatus getResultInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの最新結果の詳細情報を，ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）を実装したクラスのインスタンスとして返却します。

取得する情報がない場合は，nullを返却します。

(6)　例外

なし。

3.13　ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）は，ジョブネット直下ユニット定義情報取得の結果を保持するインターフェースです。

ジョブネット直下ユニット定義情報取得結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetDefinitionsUnderJobnetメソッドで取得できます。

getDefinitionsUnderJobnetメソッドの詳細については，「2.3.25 getDefinitionsUnderJobnetメソッド」を参照してください。

ジョブネット直下ユニット定義情報取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdGetDefinitionsUnderJobnetResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒13　ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdUnitInfo>

getUnitInfo()

ユニットの定義情報を取得します。

3.13.1　getUnitInfoメソッド

(1)　説明

ユニットの定義情報を取得します。

(2)　形式

public java.util.List<AjsCdUnitInfo> getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの定義情報を，ユニット情報インターフェース（AjsCdUnitInfo）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

該当するユニットが存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.14　ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）は，ジョブネット直下のユニットの状態を取得するオプションを保持するクラスです。

ジョブネット直下ユニット状態取得オプションクラスは，AjsCdApiインターフェースのgetStatusesUnderJobnetメソッドの取得オプションの指定に使用します。

getStatusesUnderJobnetメソッドの詳細については，「2.3.26 getStatusesUnderJobnetメソッド」を参照してください。

ジョブネット直下ユニット状態取得オプションクラスの詳細を次に示します。

クラス定義

public abstract class AjsCdGetStatusesUnderJobnetOption

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒14　ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）のメソッド一覧

メソッドの概要

public static AjsCdGetStatusesUnderJobnetOption

createAjsCdGetStatusesUnderJobnetOption()

AjsCdGetStatusesUnderJobnetOptionクラスのインスタンスを生成します。

public void

setGetHoldPlanType(GetHoldPlanType holdPlanType)

「保留予定の有無を取得するかどうか」を設定します。

public GetHoldPlanType

getGetHoldPlanType()

「保留予定の有無を取得するかどうか」を取得します。

3.14.1　createAjsCdGetStatusesUnderJobnetOptionメソッド

(1)　説明

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）のインスタンスを生成します。

(2)　形式

public static AjsCdGetStatusesUnderJobnetOption createAjsCdGetStatusesUnderJobnetOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）のインスタンスを返却します。

(6)　例外

なし。

3.14.2　setGetHoldPlanTypeメソッド

(1)　説明

「保留予定の有無を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「HOLDPLAN_NO（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetHoldPlanType(GetHoldPlanType holdPlanType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

holdPlanType

不可

「保留予定の有無を取得するかどうか」を設定します。

指定できる値と内容については，「付録A.9 (1)GetHoldPlanType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「HOLDPLAN_NO（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.14.3　getGetHoldPlanTypeメソッド

(1)　説明

setGetHoldPlanTypeメソッドで設定した「保留予定の有無を取得するかどうか」を取得します。

(2)　形式

public GetHoldPlanType getGetHoldPlanType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「保留予定の有無を取得するかどうか」を返却します。設定していない場合は「HOLDPLAN_NO（取得しない）」を返却します。

(6)　例外

なし。

3.15　ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）は，ジョブネット直下ユニット状態情報取得の結果を保持するインターフェースです。

ジョブネット直下ユニット状態情報取得結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetStatusesUnderJobnetメソッドで取得できます。

getStatusesUnderJobnetメソッドの詳細については，「2.3.26 getStatusesUnderJobnetメソッド」を参照してください。

ジョブネット直下ユニット状態情報取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdGetStatusesUnderJobnetResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒15　ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdUnitInfo>

getUnitInfo()

ユニットの状態情報を取得します。

3.15.1　getUnitInfoメソッド

(1)　説明

ユニットの状態情報を取得します。

(2)　形式

public java.util.List<AjsCdUnitInfo> getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニットの定義情報を，ユニット情報インターフェース（AjsCdUnitInfo）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

該当するユニットが存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.16　ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）は，ジョブネット直下関連線情報取得の結果を保持するインターフェースです。

ジョブネット直下関連線情報取得結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetRelationsUnderJobnetメソッドで取得できます。

getRelationsUnderJobnetメソッドの詳細については，「2.3.27 getRelationsUnderJobnetメソッド」を参照してください。

ジョブネット直下関連線情報取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdGetRelationsUnderJobnetResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒16　ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdUnitRelation>

getUnitRelationList()

関連線情報を取得します。

3.16.1　getUnitRelationListメソッド

(1)　説明

関連線情報を取得します。

(2)　形式

public java.util.List<AjsCdUnitRelation> getUnitRelationList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

関連線情報を，関連線情報インターフェース（AjsCdUnitRelation）を実装したクラスのインスタンスに格納して返却します。

該当するユニットまたは関連線が存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.17　関連線情報インターフェース（AjsCdUnitRelation）

関連線情報インターフェース（AjsCdUnitRelation）は，定義済みのユニットの関連線情報を保持するインターフェースです。

関連線情報インターフェースを実装したクラスのインスタンスは，ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）のgetUnitRelationListメソッドで取得できます。

getUnitRelationListメソッドの詳細については，「3.16.1 getUnitRelationListメソッド」を参照してください。

関連線情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdUnitRelation

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒17　関連線情報インターフェース（AjsCdUnitRelation）のメソッド一覧

メソッドの概要

public int

getPreceding()

先行ユニットのユニットIDを取得します。

public int

getSucceeding()

後続ユニットのユニットIDを取得します。

public RelationType

getRelationType()

この関連線の種別を取得します。

3.17.1　getPrecedingメソッド

(1)　説明

関連線で順序づけられたユニットのうち，先行ユニットのユニットIDを取得します。

(2)　形式

public int getPreceding()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

先行ユニットのユニットIDを返却します。

(6)　例外

なし。

3.17.2　getSucceedingメソッド

(1)　説明

関連線で順序づけられたユニットのうち，後続ユニットのユニットIDを取得します。

(2)　形式

public int getSucceeding()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

後続ユニットのユニットIDを返却します。

(6)　例外

なし。

3.17.3　getRelationTypeメソッド

(1)　説明

関連線の種別を取得します。

(2)　形式

public RelationType getRelationType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

関連線の種別をRelationTypeで返却します。

RelationTypeの詳細については，「付録A.4 (1)RelationType」を参照してください。

(6)　例外

なし。

3.18　予実績情報取得オプションクラス（AjsCdGetScheduleOption）

予実績情報取得オプションクラス（AjsCdGetScheduleOption）は，予実績情報を取得するオプションを保持するクラスです。

予実績情報取得オプションクラスは，AjsCdApiインターフェースのgetScheduleメソッドの取得オプションの指定に使用します。

getScheduleメソッドの詳細については，「2.3.28 getScheduleメソッド」を参照してください。

予実績情報取得オプションクラスの詳細を次に示します。

クラス定義

public abstract class AjsCdGetScheduleOption

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒18　予実績情報取得オプションクラス（AjsCdGetScheduleOption）のメソッド一覧

メソッドの概要

public static AjsCdGetScheduleOption

createAjsCdGetScheduleOption()

AjsCdGetScheduleOptionクラスのインスタンスを生成します。

public void

setGetHoldPlanType(GetHoldPlanType holdPlanType)

「保留予定の有無を取得するかどうか」を設定します。

public void

setSimulation(boolean simulation)

「実行シミュレーションを行うかどうか」を設定します。

public void

setFirstExecutionTime(int firstExecutionTime)

初回実行時間を設定します。

public void

setGetChangeTypeOption(boolean getItem)

「計画一時変更の有無を取得するかどうか」を設定します。

public void

setGetStartConditionOption(boolean getItem)

「起動条件の情報を取得するかどうか」を設定します。

public GetHoldPlanType

getGetHoldPlanType()

「保留予定の有無を取得するかどうか」を取得します。

public boolean

isSimulation()

「実行シミュレーションを行うかどうか」を取得します。

public int

getFirstExecutionTime()

初回実行時間を取得します。

public boolean

isGetChangeTypeOption()

「計画一時変更の有無を取得するかどうか」を取得します。

public boolean

isGetStartConditionOption()

「起動条件の情報を取得するかどうか」を取得します。

3.18.1　createAjsCdGetScheduleOptionメソッド

(1)　説明

予実績情報取得オプションクラス（AjsCdGetScheduleOption）のインスタンスを生成します。

(2)　形式

public static AjsCdGetScheduleOption createAjsCdGetScheduleOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

予実績情報取得オプションクラス（AjsCdGetScheduleOption）のインスタンスを返却します。

(6)　例外

なし。

3.18.2　setGetHoldPlanTypeメソッド

(1)　説明

「保留予定の有無を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，メソッドを呼び出さなかった場合は，「HOLDPLAN_NO（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetHoldPlanType(GetHoldPlanType holdPlanType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

holdPlanType

不可

「保留予定の有無を取得するかどうか」を設定します。

指定できる値と内容については，「付録A.9 (1)GetHoldPlanType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「HOLDPLAN_NO（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.18.3　setSimulationメソッド

(1)　説明

「実行シミュレーションを行うかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（行わない）」（デフォルト）となります。

(2)　形式

public void setSimulation(boolean simulation)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

simulation

不可

「実行シミュレーションを行うかどうか」を設定します。

行う場合は「true」を指定します。行わない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（行わない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.18.4　setFirstExecutionTimeメソッド

(1)　説明

初回実行時間を設定します。

メソッドを呼び出さなかった場合は，「1200」（デフォルト）となります。

(2)　形式

public void setFirstExecutionTime(int firstExecutionTime)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

firstExecutionTime

不可

ユニットの初回実行時間を秒で設定します。

指定できる値は1〜86,400秒です。

デフォルト（メソッドを呼び出さなかった場合）は，「1200」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.18.5　setGetChangeTypeOptionメソッド

(1)　説明

「計画一時変更の有無を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetChangeTypeOption(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

「計画一時変更の有無を取得するかどうか」を設定します。

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.18.6　setGetStartConditionOptionメソッド

(1)　説明

「起動条件の情報を取得するかどうか」を設定します。

メソッドを呼び出さなかった場合は，「false（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetStartCondition(boolean getItem)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

getItem

不可

次の起動条件情報を取得するかどうかを設定します。

起動条件の有効範囲の回数

起動条件の有効範囲の時間

起動条件の有効範囲の時間の種別

取得する場合は「true」を指定します。取得しない場合は「false」を指定します。

デフォルト（メソッドを呼び出さなかった場合）は，「false（取得しない）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.18.7　getGetHoldPlanTypeメソッド

(1)　説明

setGetHoldPlanTypeメソッドで設定した「保留予定の有無を取得するかどうか」を取得します。

(2)　形式

public GetHoldPlanType getGetHoldPlanType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「保留予定の有無を取得するかどうか」を返却します。設定していない場合は「HOLDPLAN_NO（取得しない）」を返却します。

(6)　例外

なし。

3.18.8　isSimulationメソッド

(1)　説明

setSimulationメソッドで設定した「実行シミュレーションを行うかどうか」を取得します。

(2)　形式

public boolean isSimulation()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「実行シミュレーションを行うかどうか」を返却します。設定していない場合は「false（行わない）」を返却します。

(6)　例外

なし。

3.18.9　getFirstExecutionTimeメソッド

(1)　説明

setFirstExecutionTimeメソッドで設定した初回実行時間を取得します。

(2)　形式

public int getFirstExecutionTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した初回実行時間を返却します。設定していない場合は「1200」を返却します。

(6)　例外

なし。

3.18.10　isGetChangeTypeOptionメソッド

(1)　説明

setGetChangeTypeOptionメソッドで設定した「計画一時変更の有無を取得するかどうか」を取得します。

(2)　形式

public boolean isGetChangeTypeOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「計画一時変更の有無を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.18.11　isGetStartConditionOptionメソッド

(1)　説明

setGetStartConditionOptionメソッドで設定した「起動条件の情報を取得するかどうか」を取得します。

(2)　形式

public boolean isGetStartConditionOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「起動条件の情報を取得するかどうか」を返却します。設定していない場合は「false（取得しない）」を返却します。

(6)　例外

なし。

3.19　ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）は，ジョブネットの予実績情報取得の結果を保持するインターフェースです。

ジョブネットの予実績情報取得結果インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetScheduleメソッドで取得できます。

getScheduleメソッドの詳細については，「2.3.28 getScheduleメソッド」を参照してください。

ジョブネットの予実績情報取得結果インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdGetScheduleResult

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒19　ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdSchedule>

getScheduleInGenerationList()

ユニットの予実績情報を取得します。

3.19.1　getScheduleInGenerationListメソッド

(1)　説明

ユニットの予実績情報を世代単位で取得します。

(2)　形式

public java.util.List<AjsCdSchedule> getScheduleInGenerationList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

世代ごとの予実績情報を，世代単位の予実績情報インターフェース（AjsCdSchedule）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

世代はルートジョブネットの開始日時順で返却します。世代の順番の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの世代番号を記載している個所を参照してください。

実行予実績が存在しない場合，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

(6)　例外

なし。

3.20　世代単位の予実績情報インターフェース（AjsCdSchedule）

世代単位の予実績情報インターフェース（AjsCdSchedule）は，世代単位の予実績情報を保持するインターフェースです。

世代単位の予実績情報インターフェースを実装したクラスのインスタンスは，ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）のgetScheduleInGenerationListメソッドで取得できます。

getScheduleInGenerationListメソッドの詳細については，「3.19.1 getScheduleInGenerationListメソッド」を参照してください。

世代単位の予実績情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdSchedule

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒20　世代単位の予実績情報インターフェース（AjsCdSchedule）のメソッド一覧

メソッドの概要

public java.util.List<AjsCdUnitInfo>

getUnitInfo()

予実績情報を取得します。

3.20.1　getUnitInfoメソッド

(1)　説明

予実績情報を取得します。

(2)　形式

public java.util.List<AjsCdUnitInfo> getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

予実績情報を，ユニット情報インターフェース（AjsCdUnitInfo）を実装したクラスのインスタンスに格納し，その一覧をListインターフェースを実装したクラスのインスタンスに格納して返却します。

(6)　例外

なし。

3.21　カレンダー情報インターフェース（AjsCdCalendar）

カレンダー情報インターフェース（AjsCdCalendar）は，ジョブネットのカレンダー情報を保持するインターフェースです。

カレンダー情報インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetCalendarメソッドで取得できます。

getCalendarメソッドの詳細については，「2.3.30 getCalendarメソッド」を参照してください。

カレンダー情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdCalendar

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒21　カレンダー情報インターフェース（AjsCdCalendar）のメソッド一覧

メソッドの概要

public BaseType

getBaseType()

基準日の指定値を取得します。

public MonthType

getMonthType()

月区分を取得します。

public int

getBaseDate()

基準日の日付を取得します。

public int

getBaseWeek()

基準日の週を取得します。

public WeekDay

getBaseDay()

基準日の曜日を取得します。

public java.lang.String

getBaseTime()

基準時刻を取得します。

public java.lang.String

getStartDay()

getDayListメソッドで取得した情報の開始日を取得します。

public java.util.List<DayType>

getDayList()

運用日，休業日の情報を取得します。

3.21.1　getBaseTypeメソッド

(1)　説明

基準日の指定値を取得します。

(2)　形式

public BaseType getBaseType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

基準日の指定値を，BaseTypeで返却します。

BaseTypeの詳細については，「付録A.10 (1)BaseType」を参照してください。

(6)　例外

なし。

3.21.2　getMonthTypeメソッド

(1)　説明

カレンダーの月区分を取得します。

(2)　形式

public MonthType getMonthType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

カレンダーの月区分を，MonthTypeで返却します。

MonthTypeの詳細については，「付録A.10 (2)MonthType」を参照してください。

(6)　例外

なし。

3.21.3　getBaseDateメソッド

(1)　説明

基準日が日付指定の場合，基準日の日付を取得します。

(2)　形式

public int getBaseDate()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

基準日の日付を1〜31の数値で返却します。

基準日が曜日指定の場合は0を返却します。

(6)　例外

なし。

3.21.4　getBaseWeekメソッド

(1)　説明

基準日が曜日指定の場合，基準日の週を取得します。

(2)　形式

public int getBaseWeek()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

基準日の週を1〜5の数値で返却します。

基準日が日付指定の場合は0を返却します。

(6)　例外

なし。

3.21.5　getBaseDayメソッド

(1)　説明

基準日が曜日指定の場合，基準日の曜日を取得します。

(2)　形式

public WeekDay getBaseDay()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

基準日の曜日を，WeekDayで返却します。

WeekDayの詳細については，「付録A.10 (3)WeekDay」を参照してください。

(6)　例外

なし。

3.21.6　getBaseTimeメソッド

(1)　説明

基準時刻を取得します。

(2)　形式

public java.lang.String getBaseTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

基準時刻を，「hhmm」形式の文字列（固定4文字）で返却します。

hh：「時間」を00〜23（単位：時）で返却します。

mm：「分」を00〜59（単位：分）で返却します。

(6)　例外

なし。

3.21.7　getStartDayメソッド

(1)　説明

getDayListメソッドで取得した情報の開始日を取得します。

(2)　形式

public java.lang.String getStartDay()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

運用日，休業日情報の開始日を，「YYYYMMDD」形式の文字列（固定8文字）で返却します。

YYYY：「年」を1994〜2036（単位：年）で返却します。

MM：「月」を01〜12（単位：月）で返却します。

DD：「日」を01〜31（単位：日）で返却します。

(6)　例外

なし。

3.21.8　getDayListメソッド

(1)　説明

運用日，休業日の情報を取得します。

(2)　形式

public java.util.List<DayType> getDayList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

開始日から，運用日，休業日をDayTypeのListで返却します。

DayTypeの詳細については，「付録A.10 (4)DayType」を参照してください。

(6)　例外

なし。

3.22　サマリー情報取得オプションクラス（AjsCdGetSummaryOption）

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）は，サマリー情報を取得するオプションを保持するクラスです。

サマリー情報取得オプションクラスは，AjsCdApiインターフェースのgetJobnetSummaryメソッドの取得オプションの指定に使用します。

getJobnetSummaryメソッドの詳細については，「2.3.31 getJobnetSummaryメソッド」を参照してください。

サマリー情報取得オプションクラスの詳細を次に示します。

クラス定義

public abstract class AjsCdGetSummaryOption

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒22　サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のメソッド一覧

メソッドの概要

public static AjsCdGetSummaryOption

createAjsCdGetSummaryOption()

AjsCdGetSummaryOptionクラスのインスタンスを生成します。

public void

setType(SummaryType setType)

取得対象とする情報の種類を設定します。

public void

setGetHoldPlanType(GetHoldPlanType holdPlanType)

「保留予定の有無を取得するかどうか」を設定します。

public void

setFirstExecutionTime(int firstExecutionTime)

初回実行時間を設定します。

public SummaryType

getType()

取得対象とする情報の種類を取得します。

public GetHoldPlanType

getGetHoldPlanType()

「保留予定の有無を取得するかどうか」を取得します。

public int

getFirstExecutionTime()

初回実行時間を取得します。

3.22.1　createAjsCdGetSummaryOptionメソッド

(1)　説明

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のインスタンスを生成します。

(2)　形式

public static AjsCdGetSummaryOption createAjsCdGetSummaryOption()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のインスタンスを返却します。

(6)　例外

なし。

3.22.2　setTypeメソッド

(1)　説明

取得対象とする情報の種類を設定します。

メソッドを呼び出さなかった場合は，「ALL（すべての情報を取得）」（デフォルト）となります。

(2)　形式

public void setType(SummaryType setType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

setType

不可

取得対象とする情報の種類をSummaryTypeで設定します。

指定できる値と内容については，「付録A.11 (1)SummaryType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「ALL（すべての情報を取得）」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.22.3　setGetHoldPlanTypeメソッド

(1)　説明

「保留予定の有無を取得するかどうか」を設定します。

setTypeメソッドで「ALL（すべての情報を取得）」を指定した場合にだけ設定します。

メソッドを呼び出さなかった場合は，「HOLDPLAN_NO（取得しない）」（デフォルト）となります。

(2)　形式

public void setGetHoldPlanType(GetHoldPlanType holdPlanType)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

holdPlanType

不可

「保留予定の有無を取得するかどうか」を設定します。

指定できる値と内容については，「付録A.9 (1)GetHoldPlanType」を参照してください。

デフォルト（メソッドを呼び出さなかった場合）は，「HOLDPLAN_NO（取得しない）」となります。

この項目は，setTypeメソッドで「ALL（すべての情報を取得）」を指定した場合に有効です。その他の場合は無視されます。

(5)　戻り値

なし。

(6)　例外

なし。

3.22.4　setFirstExecutionTimeメソッド

(1)　説明

初回実行時間を設定します。

メソッドを呼び出さなかった場合は，「1200」（デフォルト）となります。

(2)　形式

public void setFirstExecutionTime(int firstExecutionTime)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

firstExecutionTime

不可

ユニットの初回実行時間を秒で設定します。

指定できる値は1〜86,400秒です。

デフォルト（メソッドを呼び出さなかった場合）は，「1200」となります。

(5)　戻り値

なし。

(6)　例外

なし。

3.22.5　getTypeメソッド

(1)　説明

setTypeメソッドで設定した取得対象とする情報の種類を取得します。

(2)　形式

public SummaryType getType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した取得対象とする情報の種類を返却します。設定していない場合は「ALL（すべての情報を取得）」を返却します。

(6)　例外

なし。

3.22.6　getGetHoldPlanTypeメソッド

(1)　説明

setGetHoldPlanTypeメソッドで設定した「保留予定の有無を取得するかどうか」を取得します。

(2)　形式

public GetHoldPlanType getGetHoldPlanType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した「保留予定の有無を取得するかどうか」を返却します。設定していない場合は「HOLDPLAN_NO（取得しない）」を返却します。

(6)　例外

なし。

3.22.7　getFirstExecutionTimeメソッド

(1)　説明

setFirstExecutionTimeメソッドで設定した初回実行時間を取得します。

(2)　形式

public int getFirstExecutionTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

設定した初回実行時間を返却します。設定していない場合は「1200」を返却します。

(6)　例外

なし。

3.23　サマリー情報共通インターフェース（AjsCdJobnetSummary）

サマリー情報共通インターフェース（AjsCdJobnetSummary）は，サマリー情報を保持するインターフェースです。

サマリー情報共通インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdJobnetSummary

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒23　サマリー情報共通インターフェース（AjsCdJobnetSummary）のメソッド一覧

メソッドの概要

public long

getSchEndTime()

終了予定日時を取得します。

public int

getAbnormalCount()

異常終了したユニットの数を取得します。

public int

getWarningCount()

警告終了したユニットの数を取得します。

public int

getDelayCount()

遅延したユニットの数を取得します。

public int

getHoldCount()

保留中のユニットの数を取得します。

public int

getWaitCount()

開始待ちのユニットの数を取得します。

public int

getRunCount()

実行中のユニットの数を取得します。

public int

getNormalCount()

正常終了したユニットの数を取得します。

public int

getScheduleCount()

予定ユニットの数を取得します。

3.23.1　getSchEndTimeメソッド

(1)　説明

取得対象ユニット全体の終了予定日時を取得します。

すべてのユニットが終了している場合は，取得対象ユニット全体の終了日時を取得します。

(2)　形式

public long getSchEndTime()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

終了予定日時を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で返却します。

(6)　例外

なし。

3.23.2　getAbnormalCountメソッド

(1)　説明

取得対象ユニットのうち，異常終了したユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

異常検出終了

順序不正

中断

強制終了

起動失敗

終了状態不明

繰り越し未実行※

監視打ち切り終了

注※

ネストジョブネットと上位ジョブネットのスケジュールの不一致や，実行中止のために実行予定がないユニットは，「未計画」状態になります。この「未計画」状態のユニットは，ルートジョブネットの繰り越し未実行によって「繰り越し未実行」状態に遷移します。この場合，「繰り越し未実行」状態のユニットでも監視対象外として扱われます。

(2)　形式

public int getAbnormalCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

異常終了したユニットの数を数値で返却します。

(6)　例外

なし。

3.23.3　getWarningCountメソッド

(1)　説明

取得対象ユニットのうち，警告終了したユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

警告検出終了

(2)　形式

public int getWarningCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

警告終了したユニットの数を数値で返却します。

(6)　例外

なし。

3.23.4　getDelayCountメソッド

(1)　説明

取得対象ユニットのうち，遅延したユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

開始遅延※

終了遅延※

注※

1つのユニットに開始遅延と終了遅延が同時に発生した場合でも，遅延したユニットの数は1として数えられます。

操作対象ユニットの配下のユニットに遅延（ネスト開始遅延またはネスト終了遅延）が発生した場合，操作対象ユニット自体は遅延ユニットとしてカウントされません。

(2)　形式

public int getDelayCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

遅延したユニットの数を数値で返却します。

(6)　例外

なし。

3.23.5　getHoldCountメソッド

(1)　説明

取得対象ユニットのうち，保留中のユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

保留中

(2)　形式

public int getHoldCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

保留中のユニットの数を数値で返却します。

(6)　例外

なし。

3.23.6　getWaitCountメソッド

(1)　説明

取得対象ユニットのうち，開始待ちのユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

開始時刻待ち

先行終了待ち

実行待ち

キューイング

起動条件待ち

(2)　形式

public int getWaitCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

開始待ちのユニットの数を数値で返却します。

(6)　例外

なし。

3.23.7　getRunCountメソッド

(1)　説明

取得対象ユニットのうち，実行中のユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

実行中

警告検出実行中

異常検出実行中

監視中

(2)　形式

public int getRunCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行中のユニットの数を数値で返却します。

(6)　例外

なし。

3.23.8　getNormalCountメソッド

(1)　説明

取得対象ユニットのうち，正常終了したユニットの数を取得します。

次に示す状態のユニットがカウント対象となります。

正常終了

正常終了−偽

監視未起動終了

監視中断

監視正常終了

(2)　形式

public int getNormalCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

正常終了したユニットの数を数値で返却します。

(6)　例外

なし。

3.23.9　getScheduleCountメソッド

(1)　説明

取得対象ユニットの総数（予定ユニット数）を取得します。

なお，次に示す状態のユニットはカウント対象外となります。

起動条件付きジョブネットの監視世代が次に示す状態にある場合，その配下のユニット

監視中

監視正常終了

監視未起動終了

監視打ち切り終了

監視中断

繰り越し未実行

ジョブネットコネクタの接続先ジョブネット，およびその配下のユニット

ルートリモートジョブネットおよびネストリモートジョブネットの配下のユニット

次に示す状態のユニット

未登録

未計画

計画未実行

閉塞

未実行終了

繰り越し未実行（実行予定なし）

(2)　形式

public int getScheduleCount()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

予定ユニット数を数値で返却します。

(6)　例外

なし。

3.24　サマリー情報全体インターフェース（AjsCdTotalSummary）

サマリー情報全体インターフェース（AjsCdTotalSummary）は，全世代分のサマリー情報を保持するインターフェースです。

サマリー情報全体インターフェースを実装したクラスのインスタンスは，AjsCdApiインターフェースのgetJobnetSummaryメソッドで取得できます。

getJobnetSummaryメソッドの詳細については，「2.3.31 getJobnetSummaryメソッド」を参照してください。

サマリー情報全体インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdTotalSummary extends AjsCdJobnetSummary

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒24　サマリー情報全体インターフェース（AjsCdTotalSummary）のメソッド一覧

メソッドの概要

public int

getGenerationNumber()

世代数を取得します。

public long

getSchEndTime()

終了予定日時を取得します。

メソッドの仕様については，「3.23.1 getSchEndTimeメソッド」を参照してください。

public int

getAbnormalCount()

異常終了したユニットの数を取得します。

メソッドの仕様については，「3.23.2 getAbnormalCountメソッド」を参照してください。

public int

getWarningCount()

警告終了したユニットの数を取得します。

メソッドの仕様については，「3.23.3 getWarningCountメソッド」を参照してください。

public int

getDelayCount()

遅延したユニットの数を取得します。

メソッドの仕様については，「3.23.4 getDelayCountメソッド」を参照してください。

public int

getHoldCount()

保留中のユニットの数を取得します。

メソッドの仕様については，「3.23.5 getHoldCountメソッド」を参照してください。

public int

getWaitCount()

開始待ちのユニットの数を取得します。

メソッドの仕様については，「3.23.6 getWaitCountメソッド」を参照してください。

public int

getRunCount()

実行中のユニットの数を取得します。

メソッドの仕様については，「3.23.7 getRunCountメソッド」を参照してください。

public int

getNormalCount()

正常終了したユニットの数を取得します。

メソッドの仕様については，「3.23.8 getNormalCountメソッド」を参照してください。

public int

getScheduleCount()

予定ユニットの数を取得します。

メソッドの仕様については，「3.23.9 getScheduleCountメソッド」を参照してください。

public java.util.List<AjsCdSummaryInGeneration>

getSummaryInGenerationList()

1世代分のサマリー情報のリストを取得します。

3.24.1　getGenerationNumberメソッド

(1)　説明

取得対象となる世代の数を取得します。

(2)　形式

public int getGenerationNumber()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

世代の数を数値で返却します。

(6)　例外

なし。

3.24.2　getSummaryInGenerationListメソッド

(1)　説明

世代ごとのサマリー情報をサマリー情報世代インターフェース（AjsCdSummaryInGeneration）のリストで取得します。

(2)　形式

public java.util.List<AjsCdSummaryInGeneration> getSummaryInGenerationList()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のListを返却します。

次に示す場合は，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

取得対象となる世代が存在しない場合

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のsetTypeメソッドで「WHOLE（全体情報だけを取得）」を指定している場合

世代はルートジョブネットの開始日時順で返却します。世代の順番の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの世代番号を記載している個所を参照してください。

(6)　例外

なし。

3.25　サマリー情報世代インターフェース（AjsCdSummaryInGeneration）

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）は，1世代分のサマリー情報を保持するインターフェースです。

サマリー情報世代インターフェースを実装したクラスのインスタンスは，サマリー情報全体インターフェース（AjsCdTotalSummary）のgetSummaryInGenerationListメソッドで取得できます。

getSummaryInGenerationListメソッドの詳細については，「3.24.2 getSummaryInGenerationListメソッド」を参照してください。

サマリー情報世代インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdSummaryInGeneration extends AjsCdJobnetSummary

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒25　サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のメソッド一覧

メソッドの概要

public long

getSchEndTime()

終了予定日時を取得します。

メソッドの仕様については，「3.23.1 getSchEndTimeメソッド」を参照してください。

public int

getAbnormalCount()

異常終了したユニットの数を取得します。

メソッドの仕様については，「3.23.2 getAbnormalCountメソッド」を参照してください。

public int

getWarningCount()

警告終了したユニットの数を取得します。

メソッドの仕様については，「3.23.3 getWarningCountメソッド」を参照してください。

public int

getDelayCount()

遅延したユニットの数を取得します。

メソッドの仕様については，「3.23.4 getDelayCountメソッド」を参照してください。

public int

getHoldCount()

保留中のユニットの数を取得します。

メソッドの仕様については，「3.23.5 getHoldCountメソッド」を参照してください。

public int

getWaitCount()

開始待ちのユニットの数を取得します。

メソッドの仕様については，「3.23.6 getWaitCountメソッド」を参照してください。

public int

getRunCount()

実行中のユニットの数を取得します。

メソッドの仕様については，「3.23.7 getRunCountメソッド」を参照してください。

public int

getNormalCount()

正常終了したユニットの数を取得します。

メソッドの仕様については，「3.23.8 getNormalCountメソッド」を参照してください。

public int

getScheduleCount()

予定ユニットの数を取得します。

メソッドの仕様については，「3.23.9 getScheduleCountメソッド」を参照してください。

public java.lang.String

getExecID()

実行IDを取得します。

public java.util.List<AjsCdUnitInfo>

getUnitInfo()

ユニット詳細情報のリストを取得します。

3.25.1　getExecIDメソッド

(1)　説明

実行IDを取得します。

(2)　形式

public java.lang.String getExecID()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

実行IDを「@［mmmm］｛A〜Z｝nnnn」の形式で返却します。

(6)　例外

なし。

3.25.2　getUnitInfoメソッド

(1)　説明

指定したルートジョブネット，ルートリモートジョブネット，またはプランニンググループ，およびその配下のユニットの詳細情報をユニット情報インターフェース（AjsCdUnitInfo）のリストで取得します。

なお，指定したユニットがルートリモートジョブネットの場合，その配下のユニットの情報は取得されません。また，指定したユニットがプランニンググループの場合，その配下のユニットの情報だけが取得されます。

(2)　形式

public java.util.List<AjsCdUnitInfo> getUnitInfo()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ユニット情報インターフェース（AjsCdUnitInfo）のListを返却します。

次に示す場合は，要素数0個のListインターフェースを実装したクラスインスタンスを返却します。

取得対象となるユニットが存在しない場合

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のsetTypeメソッドで「GEN（全体情報と世代情報を取得）」を指定している場合

(6)　例外

なし。

3.26　スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）

スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）は，スケジューラーサービスの定義を保持するインターフェースです。

スケジューラーサービス定義インターフェースを実装したクラスのインスタンスは， AjsCdApiインターフェースのenumSchServiceメソッドで取得できます。

enumSchServiceメソッドの詳細については，「2.3.33 enumSchServiceメソッド」を参照してください。

スケジューラーサービス定義インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdSchServiceDef

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒26　スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）のメソッド一覧

メソッドの概要

public java.lang.String

getServiceName()

スケジューラーサービス名を取得します。

3.26.1　getServiceNameメソッド

(1)　説明

スケジューラーサービス名を取得します。

(2)　形式

public java.lang.String getServiceName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

スケジューラーサービス名を1〜30バイトの文字列で返却します。

(6)　例外

なし。

3.27　スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）

スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）は，スケジューラーサービスの情報を保持するインターフェースです。

スケジューラーサービス情報インターフェースを実装したクラスのインスタンスは， AjsCdApiインターフェースのgetSchServiceInfoメソッドで取得できます。

getSchServiceInfoメソッドの詳細については，「2.3.34 getSchServiceInfoメソッド」を参照してください。

なお，接続先のスケジューラーサービスの設定を接続中に変更した場合は，再度ログインし直してください。ログインし直さない場合は，変更前の情報が取得されるときがあります。

スケジューラーサービス情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdSchServiceInfo

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒27　スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）のメソッド一覧

メソッドの概要

public java.lang.String

getCharCode()

要求先JP1/AJS3 - Managerのスケジューラーサービスに設定されている文字コードを取得します。

public java.lang.String

getDeflenType()

要求先JP1/AJS3 - Managerのスケジューラーサービスに設定されている，UTF-8環境の場合に指定できる文字数を，シフトJIS環境の場合に指定できる文字数と同じにするかどうかの設定を取得します。

public DBType

getDBType()

スケジューラーサービスのDB種別を取得します。

public boolean

isOperationNet()

オペレーションネット用のスケジューラーサービス（JP1/IM - Planning Operationで管理される）かどうかを取得します。

3.27.1　getCharCodeメソッド

(1)　説明

要求先JP1/AJS3 - Managerのスケジューラーサービスに設定されている文字コードを取得します。スケジューラーサービスの環境設定パラメーター「AJSCHARCODE」の値です。

なお，接続先のスケジューラーサービスの文字コードを接続中に変更した場合は，再度ログインし直してください。ログインし直さない場合は，変更前の情報が取得されるときがあります。

(2)　形式

public java.lang.String getCharCode(
　　java.lang.String manager,
　　java.lang.String serviceName)

(3)　実行権限

なし。

(4)　引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。

(5)　戻り値

要求先JP1/AJS3 - Managerのスケジューラーサービスの環境設定パラメーター「AJSCHARCODE」で設定されている値を，文字列で返却します。

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

3.27.2　getDeflenTypeメソッド

(1)　説明

要求先JP1/AJS3 - Managerのスケジューラーサービスに設定されている，UTF-8環境の場合に指定できる文字数を，シフトJIS環境の場合に指定できる文字数と同じにするかどうかの設定を取得します。スケジューラーサービスの環境設定パラメーター「DEFLENTYPE」の値です。

(2)　形式

public java.lang.String getDeflenType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

要求先JP1/AJS3 - Managerのスケジューラーサービスの環境設定パラメーター「DEFLENTYPE」で設定されている値を，文字列で返却します。

接続先JP1/AJS3 - Managerが，環境設定パラメーター「DEFLENTYPE」をサポートしていない場合は，デフォルト値（byte）を返却します。

(6)　例外

なし。

3.27.3　getDBTypeメソッド

(1)　説明

スケジューラーサービスのDB種別を取得します。

(2)　形式

public DBType getDBType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

スケジューラーサービスのDB種別をDBTypeで返却します。

DBTypeの詳細については，「付録A.7 (1)DBType」を参照してください。

(6)　例外

なし。

3.27.4　isOperationNetメソッド

(1)　説明

オペレーションネット用のスケジューラーサービス（JP1/IM - Planning Operationで管理される）かどうかを取得します。

(2)　形式

public boolean isOperationNet()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

オペレーションネット用のスケジューラーサービスの場合，「true」を返却します。

オペレーションネット用のスケジューラーサービスでない場合，「false」を返却します。

(6)　例外

なし。

3.28　JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）

JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）は，JP1/AJS3 - Managerの情報を保持するインターフェースです。

JP1/AJS3 - Manager情報インターフェースを実装したインスタンスは，AjsCdApiインターフェースのgetAJSManagerInfoメソッドで取得できます。

getAJSManagerInfoメソッドの詳細については，「2.3.35 getAJSManagerInfoメソッド」を参照してください。

なお，接続先のJP1/AJS3 - Managerの構成などを接続中に変更した場合は，再度ログインし直してください。ログインし直さない場合は，変更前の情報が取得されるときがあります。

JP1/AJS3 - Manager情報インターフェースの詳細を次に示します。

クラス定義

public interface AjsCdAJSManagerInfo

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api.data

メソッド一覧

表3‒28　JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）のメソッド一覧

メソッドの概要

public java.lang.String

getVersion()

バージョン情報を取得します。

public OSType

getOSType()

JP1/AJS3 - ManagerのOS種別を取得します。

public OSDetail

getOSDetail()

JP1/AJS3 - ManagerのOS詳細を取得します。

public OSArchitecture

getOSArchitecture()

JP1/AJS3 - ManagerのOSアーキテクチャを取得します。

public LinuxVersion

getLinuxVersion()

JP1/AJS3 - ManagerのLinuxのバージョンを取得します。

public DBConfigType

getDBConfig()

データベースの構成を取得します。

3.28.1　getVersionメソッド

(1)　説明

バージョン情報を取得します。

(2)　形式

public java.lang.String getVersion()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

バージョン情報を「VVRR」の形式の文字列で返却します。

(6)　例外

なし。

3.28.2　getOSTypeメソッド

(1)　説明

JP1/AJS3 - ManagerのOS種別を取得します。

(2)　形式

public OSType getOSType()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1/AJS3 - ManagerのOS種別をOSTypeで返却します。

OSTypeの詳細については，「付録A.8 (1)OSType」を参照してください。

(6)　例外

なし。

3.28.3　getOSDetailメソッド

(1)　説明

JP1/AJS3 - ManagerのOS詳細を取得します。

(2)　形式

public OSDetail getOSDetail()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1/AJS3 - ManagerのOS詳細をOSDetaiで返却します。

OSDetailの詳細については，「付録A.8 (2)OSDetail」を参照してください。

(6)　例外

なし。

3.28.4　getOSArchitectureメソッド

(1)　説明

JP1/AJS3 - ManagerのOSアーキテクチャを取得します。

(2)　形式

public OSArchitecture getOSArchitecture()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1/AJS3 - ManagerのOSアーキテクチャをOSArchitectureで返却します。

OSArchitectureの詳細については，「付録A.8 (3)OSArchitecture」を参照してください。

(6)　例外

なし。

3.28.5　getLinuxVersionメソッド

(1)　説明

JP1/AJS3 - ManagerのLinuxのバージョンを取得します。

(2)　形式

public LinuxVersion getLinuxVersion()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

JP1/AJS3 - ManagerのLinuxのバージョンをLinuxVersionで返却します。

LinuxVersionの詳細については，「付録A.8 (4)LinuxVersion」を参照してください。

(6)　例外

なし。

3.28.6　getDBConfigメソッド

(1)　説明

データベース構成を取得します。

(2)　形式

public DBConfigType getDBConfig()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

データベース構成をDBConfigTypeで返却します。

DBConfigTypeの詳細については，「付録A.8 (5)DBConfigType」を参照してください。

(6)　例外

なし。

4　例外クラス

例外クラスのクラスおよびメソッドについて説明します。

4.1　AjsCdException例外クラス

JP1/AJS3 - SDKの共通の例外クラス，およびJP1/AJS3 - SDKが提供する例外クラスのスーパークラスです。また，初期化関連エラー，システムエラー，内部エラーなどが発生した場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

要因例外：getCauseメソッド

AjsCdException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdException extends java.lang.Exception

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.common

メソッド一覧

表4‒1　AjsCdException例外クラスのメソッド一覧

メソッドの概要

public AjsCdReturnCode

getReturnCode()

エラーリターンコード情報を取得します。

public java.lang.String

getMessage()

エラーの内容を示すメッセージテキストを取得します。

public java.lang.Throwable

getCause()

このエラーの要因となった例外クラスを取得します。

4.1.1　getReturnCodeメソッド

(1)　説明

エラーリターンコード情報を取得します。

(2)　形式

public AjsCdReturnCode getReturnCode()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リターンコード情報を格納したAjsCdReturnCodeクラスのインスタンスを返却します。

4.1.2　getMessageメソッド

(1)　説明

エラーの内容を示すメッセージテキストを取得します。

(2)　形式

public java.lang.String getMessage()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

エラーの内容を示すメッセージテキストを返却します。

4.1.3　getCauseメソッド

(1)　説明

このエラーの要因となった例外クラスを取得します。

(2)　形式

public java.lang.Throwable getCause()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

このエラーの要因となった例外クラスが存在する場合は，java.lang.Throwableクラスのクラスインスタンスを返却します。このエラーの要因となった例外クラスが存在しない場合は，「null」を返却します。

4.2　AjsCdAJSManagerException例外クラス

接続先のJP1/AJS3 - Managerでエラーが発生した場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

各メソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdAJSManagerException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdAJSManagerException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.3　AjsCdInvalidTokenException例外クラス

接続先のJP1/AJS3 - Managerで認証情報のエラーが発生した場合に報告される例外クラスです。

この例外クラスが報告された場合，loginメソッドによる認証情報が認証サーバの再起動などで無効になっているため，loginメソッドによる再認証が必要となります。

loginメソッドの詳細については，「2.3.1 loginメソッド」を参照してください。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

ログイン情報が無効となったJP1/AJS3 - Managerホスト名：getManagerメソッド

ログイン情報が無効となったJP1ユーザー名：getUserNameメソッド

getReturnCodeメソッド，getMessageメソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdInvalidTokenException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdInvalidTokenException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

表4‒2　AjsCdInvalidTokenException例外クラスのメソッド一覧

メソッドの概要

public java.lang.String

getManager()

ログイン情報が無効となったJP1/AJS3 - Managerのホスト名を取得します。

public java.lang.String

getUserName()

ログイン情報が無効となったJP1ユーザー名を取得します。

そのほかのメソッドについては，「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.3.1　getManagerメソッド

(1)　説明

ログイン情報が無効となったJP1/AJS3 - Managerのホスト名を取得します。

(2)　形式

public java.lang.String getManager()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ログイン情報が無効となったJP1/AJS3 - Managerのホスト名を返却します。

4.3.2　getUserNameメソッド

(1)　説明

ログイン情報が無効となったJP1ユーザー名を取得します。

(2)　形式

public java.lang.String getUserName()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

ログイン情報が無効となったJP1ユーザー名を返却します。

4.4　AjsCdApiParameterException例外クラス

APIの引数にエラーがある場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

要因例外：getCauseメソッド

各メソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdApiParameterException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdApiParameterException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.5　AjsCdApiSequenceException例外クラス

APIの呼び出しシーケンスにエラーがある場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

各メソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdApiSequenceException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdApiSequenceException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.6　AjsCdApiCancelException例外クラス

APIがcancelSearchメソッドでキャンセルされた場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

各メソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdApiCancelException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdApiCancelException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.7　AjsCdApiException例外クラス

JP1/AJS3 - SDKのAPIの共通の例外クラスです。JP1/AJS3 - Managerとの接続関連のエラーなどが発生した場合に報告される例外クラスです。

この例外クラスで保持する情報と取得メソッドを次に示します。

エラーコード：getReturnCodeメソッド

メッセージ：getMessageメソッド

要因例外：getCauseメソッド

各メソッドの詳細については，「4.1 AjsCdException例外クラス」のメソッドを参照してください。

AjsCdApiException例外クラスの詳細を次に示します。

クラス定義

public class AjsCdApiException extends AjsCdException

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.api

メソッド一覧

「表 4-1 AjsCdException例外クラスのメソッド一覧」を参照してください。

4.8　AjsCdReturnCodeクラス

getReturnCodeメソッドで取得したエラーリターンコード情報（終了コードと詳細コード）を保持するクラスです。

AjsCdReturnCodeクラスの詳細を次に示します。

クラス定義

public class AjsCdReturnCode

パッケージ名

jp.co.Hitachi.soft.jp1.ajs.cd.common

メソッド一覧

表4‒3　AjsCdReturnCodeクラスのメソッド一覧

メソッドの概要

public ReturnCode

getReturnCode()

リターンコード情報の終了コードを取得します。

public DetailCode

getDetailCode()

リターンコード情報の詳細コードを取得します。

4.8.1　getReturnCodeメソッド

(1)　説明

リターンコード情報の終了コードを取得します。

(2)　形式

public ReturnCode getReturnCode()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リターンコード情報の終了コードをReturnCodeで返却します。

ReturnCodeの詳細については，「付録A.13 (1)ReturnCode」を参照してください。

4.8.2　getDetailCodeメソッド

(1)　説明

リターンコード情報の詳細コードを取得します。

(2)　形式

public DetailCode getDetailCode()

(3)　実行権限

なし。

(4)　引数

なし。

(5)　戻り値

リターンコード情報の詳細コードをDetailCodeで返却します。

DetailCodeの詳細については，「付録A.13 (2)DetailCode」を参照してください。

第2編　メッセージ編

5　メッセージ

JP1/AJS3 - SDKのメッセージについて説明します。

5.1　メッセージの分類

メッセージの分類について，次の表に示します。

表5‒1　メッセージの分類

メッセージID

内容

KNAK0001〜KNAK0100

トレース関連（開始/終了/キャンセルなど）

KNAK0101〜KNAK0200

環境設定，システムプロパティ関連

KNAK0201〜KNAK0250

ログ出力関連

KNAK0401〜KNAK0500

通信制御（接続/送信/受信）関連，論理的な送受信データ不整合など

KNAK0501〜KNAK1000

APIの接続先（JP1/AJS3 - Manager）に関するエラー

KNAK1001〜KNAK1500

APIのシンタックス不正，シーケンス不正など

KNAK1501〜KNAK1600

致命的なエラー

KNAK1601〜KNAK1700

インストーラー関連

5.2　メッセージの形式

JP1/AJS3 - SDKが出力するメッセージの形式を次に示します。

JP1/AJS3 - SDKは，日本語と英語のメッセージをサポートしています。

5.2.1　メッセージの出力形式

出力するメッセージの形式を示します。メッセージはメッセージIDとそれに続くメッセージテキストで構成されます。形式を次に示します。

KNAKnnnn-Z　メッセージテキスト

メッセージIDは，次の内容を示しています。

K

システム識別子を示します。

NAK

JP1/AJS3 - SDKのメッセージであることを示します。

nnnn

メッセージの通し番号を示します。

Z

メッセージの種類を以下に示します。

E：エラー

処理は中断されます。ただし，コマンドで複数の任意名を指定した場合，それぞれの任意名の処理に対して出力されますが，コマンドの処理は続行されます。

W：警告

メッセージ出力後，処理は続けられます。

I：通知

ユーザーに情報を知らせます。

5.2.2　メッセージの記載形式

このマニュアルでのメッセージの記載形式を示します。ゴシックで書かれている部分は，メッセージが表示されるたびに表示内容が変わる個所を示しています。また，メッセージをメッセージID順に記載しています。記載形式の例を次に示します。

メッセージID

英語メッセージテキスト

日本語メッセージテキスト

メッセージの説明文

（S）

システムの処置を示します。

（O）

メッセージが出力されたときに，オペレーターのとる処置を示します。

5.2.3　メッセージの出力先

インストーラーのメッセージは，メッセージダイアログボックスに出力されます。それ以外のメッセージは，JP1/AJS3 - SDKの共通トレースログまたはトレースログに出力されます。共通トレースログまたはトレースログに出力できない場合は，標準エラー出力に出力されることがあります。

Windowsイベントログ，日立統合トレースログ，およびJP1イベントログには出力しません。

5.3　メッセージ一覧

5.3.1　KNAK0001〜KNAK0100

トレース関連（開始/終了/キャンセルなど）のメッセージの一覧を次に示します。

KNAK0001-I

Method processing will now start.メソッド情報

メソッドの処理を開始します メソッド情報

メソッドの処理を開始したことを通知するメッセージです。

（S）

メソッドの処理を開始したことをログに出力しました。

メソッド情報

メソッド情報にはメソッド名のほか，AjsCdApi識別子やアプリケーション名を表示する

KNAK0002-I

Method processing ended. (method = メソッド情報)

メソッドの処理を終了しました メソッド:メソッド情報

メソッドの処理が正常終了したことを通知するメッセージです。

（S）

メソッドの処理が正常終了したことをログに出力しました。

KNAK0004-E

An error occurred during processing of a method. (method = メソッド情報, 保守情報1, 保守情報2)

メソッドの処理でエラーが発生しました メソッド:メソッド情報 保守情報1 保守情報2

メソッドの処理中にエラーが発生したことを通知するメッセージです。

（S）

メソッドの処理中にエラーが発生したことをログに出力しました。

（O）

このメッセージの前後に出力されるメッセージに従って対処してください。

KNAK0005-I

例外クラス情報:例外発生の場所情報

例外クラス情報(例外発生の場所情報)

例外の発生した場所を示すメッセージです。

（S）

エラーの発生した場所をログに出力しました。

KNAK0006-I

スタックトレース情報

スタックトレース情報

スタックトレース情報を示すメッセージです。

（S）

スタックトレース情報をログに出力しました。

KNAK0007-I

メソッド引数情報

メソッド引数情報

メソッドの引数情報を示すメッセージです。

（S）

メソッドの引数情報をログに出力しました。

KNAK0008-I

Set a return value for メソッド名. (クラス名 サイズ)

メソッド名の戻り値を設定します クラス名 サイズ

メソッドの戻り値情報を示すメッセージです。

（S）

メソッドの戻り値情報をログに出力しました。

5.3.2　KNAK0101〜KNAK0200

環境設定，システムプロパティ関連のメッセージの一覧を次に示します。

KNAK0101-W

The file (ファイル名) was not found. Processing will continue using the default values.

ファイル(ファイル名)が見つかりません。デフォルト値を仮定して処理を続行します

ファイルが見つかりません。

（S）

デフォルト値を仮定して処理を続行します。

KNAK0102-E

An attempt to read the file (ファイル名) failed. (maintenance information = 保守情報)

ファイル(ファイル名)の読み込みに失敗しました 保守情報:保守情報

「ファイル名」のファイル入力処理でエラーが発生しました。次の原因が考えられます。

ファイル名，またはフォルダ名に使用できない文字を指定している。

ファイル名，フォルダ名，またはファイルパスの長さが正しくない。

ファイル，およびファイルを格納するフォルダに対するアクセス権がない。

ディスクの空き容量が不足している。

ほかのプログラムで編集中である。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK0103-E

An error occurred during the accessing of the file. (file = ファイル名, maintenance information = 保守情報)

ファイルアクセス中にエラーが発生しました ファイル:ファイル名 保守情報:保守情報

「ファイル名」のファイル入力処理でエラーが発生しました。次の原因が考えられます。

ファイル名，またはフォルダ名に使用できない文字を指定している。

ファイル名，フォルダ名，またはファイルパスの長さが正しくない。

ファイル，およびファイルを格納するフォルダに対するアクセス権がない。

ディスクの空き容量が不足している。

ほかのプログラムで編集中である。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK0104-E

The specified value for the keyword is invalid. (location = 場所, keyword = キーワード)

キーワードに指定されている値に誤りがあります 場所:場所 キーワード:キーワード

キーワードの値を誤って指定しています。

（S）

処理を中断します。

（O）

「キーワード」に指定している値を修正したあと，JP1/AJS3 - SDKを再起動してください。

KNAK0105-W

A keyword is not specified. Processing will continue using the default value. (location = 場所, keyword = キーワード, default = デフォルト値)

キーワードが指定されていません。デフォルト値を仮定して処理を続行します 場所:場所 キーワード:キーワード デフォルト値:デフォルト値

キーワードが指定されていないため，デフォルト値を仮定して処理を続行します。

（S）

デフォルト値を仮定して処理を続行します。

KNAK0106-E

A keyword is not specified. (location = 場所, keyword = キーワード)

キーワードが指定されていません 場所:場所 キーワード:キーワード

必須のキーワードが指定されていません。

（S）

処理を中断します。

（O）

キーワードと値を指定したあと，JP1/AJS3 - SDKを再起動してください。

KNAK0107-I

キーワード名=値

キーワード名=値

メモリー上に読み込んだ構成定義情報を通知するメッセージです。

（S）

メモリー上に読み込んだ構成定義情報をログに出力しました。

KNAK0108-W

FILE RETRY WAITING ERR (maintenance information = 保守情報1, 保守情報2)

FILE RETRY WAITING ERR 保守情報:保守情報1, 保守情報2

ファイルアクセスの再試行待ちに失敗したことを通知するメッセージです。

（S）

ファイルアクセスの再試行待ちに失敗したことをログに出力しました。

KNAK0109-W

FILE CLOSE ERR (maintenance information = 保守情報1, 保守情報2)

FILE CLOSE ERR 保守情報:保守情報1, 保守情報2

ファイルのクローズ処理に失敗したことを通知するメッセージです。

（S）

ファイルのクローズ処理に失敗したことをログに出力しました。

KNAK0110-I

The file (ファイル名) was read.

ファイル(ファイル名)を読み込みました

ファイルを読み込んだことを通知するメッセージです。

（S）

ファイルを読み込んだことをログに出力しました。

5.3.3　KNAK0201〜KNAK0250

ログ出力関連のメッセージの一覧を次に示します。

KNAK0201-E

The log output processing could not be initialized. (detailed information = 詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6)

ログ出力処理の初期化に失敗しました 詳細情報:詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6

ログ出力処理の初期化処理でエラーが発生しました。次の原因が考えられます。

ログフォルダ以下のファイルに対するアクセス権がない

ディスクの空き容量が不足している

64ビット版のJava Runtime Environmentを使用している

ログフォルダの場所については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - SDKの運用フォルダについて記載している個所を参照してください。

（S）

処理を中断します。

（O）

エラーの原因を取り除いてください。解決できない場合は，JP1/AJS3 - SDKの構成が壊れていることが考えられます。修復インストールしてください。

KNAK0202-W

The log could not be output. (detailed information = 詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6, 詳細情報7, 詳細情報8)

ログの出力に失敗しました 詳細情報:詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6, 詳細情報7, 詳細情報8

ログ出力処理でエラーが発生しました。次の原因が考えられます。

ログフォルダ以下のファイルに対するアクセス権がない

ディスクの空き容量が不足している

ログフォルダの場所については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - SDKの運用フォルダについて記載している個所を参照してください。

（S）

ログの出力に失敗したことをログに出力して，処理を続行します。

（O）

エラーの原因を取り除いてください。解決できない場合は，JP1/AJS3 - SDKの構成が壊れていることが考えられます。修復インストールしてください。

KNAK0203-W

Log output processing failed to complete. (detailed information = 詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6, 詳細情報7, 詳細情報8)

ログ出力処理の終了に失敗しました 詳細情報:詳細情報1, 詳細情報2, 詳細情報3, 詳細情報4, 詳細情報5, 詳細情報6, 詳細情報7, 詳細情報8

ログ出力処理の終了処理でエラーが発生しました。次の原因が考えられます。

ログフォルダ以下のファイルに対するアクセス権がない

ディスクの空き容量が不足している

ログフォルダの場所については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - SDKの運用フォルダについて記載している個所を参照してください。

（S）

ログ出力処理の終了処理に失敗したことをログに出力して，処理を続行します。

（O）

エラーの原因を取り除いてください。解決できない場合は，JP1/AJS3 - SDKの構成が壊れていることが考えられます。修復インストールしてください。

5.3.4　KNAK0401〜KNAK0500

通信制御（接続/送信/受信）関連，論理的な送受信データ不整合などのメッセージの一覧を次に示します。

KNAK0401-E

The data to the connection destination could not be sent or received. (maintenance information = 保守情報1, 保守情報2)

接続先とのデータの送受信に失敗しました 保守情報:保守情報1, 保守情報2

JP1/AJS3 - Managerとのデータの送受信に失敗しました。

（S）

処理を中断します。

（O）

次の原因が考えられます。

ネットワークの一時的な問題

ネットワークの一時的な問題が考えられます。ユニットを操作するメソッド実行時にこのメッセージが表示された場合は，操作が有効になっているかどうかを確認してください。有効になっていない場合や，データの取得時の場合は，メソッドを再実行してください。

接続先JP1/AJS3 - Managerで異常が発生している

何度もこのメッセージが表示される場合は，JP1/AJS3 - Managerで異常が発生しているおそれがあります。JP1/AJS3 - Managerのホストにある，Windowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。ログファイルの内容については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

また，接続先ホストがWindowsで，かつログイン直後にこのメッセージが出力される場合は，接続先ホストでデスクトップヒープ領域不足が発生しているおそれがあります。接続先ホストでデスクトップヒープ領域の消費を抑える設定（環境設定パラメーターREUSELOGON，および環境設定パラメーターLOGONSHMAX）をしてださい。

環境設定パラメーターの詳細については，マニュアル「JP1/Automatic Job Management System 3 構築ガイド2」のスケジューラーサービス環境設定について記載している個所を参照してください。

接続先JP1/AJS3 - Managerの接続許可設定ファイルに登録されていない

接続先JP1/AJS3 - Managerの接続許可設定ファイルに接続元JP1/AJS3 - SDKのホストが登録されていない場合は，接続先JP1/AJS3 - Managerの統合トレースログに出力されているKAVS8040-Eメッセージの対処方法に従ってください。

その他

上記以外の要因として，ほかのプログラムが使用しているポートに接続している可能性があります。ポート番号の定義が接続先のポート番号（jp1ajs3cdinetd）と一致しているかどうかを確認してください。

KNAK0402-E

A timeout occurred while waiting for the response from the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先からの応答待ちにタイムアウトしました 保守情報:保守情報1, 保守情報2

JP1/AJS3 - Managerからの応答待ちでタイムアウトが発生しました。次の原因が考えられます。

JP1/AJS3 - Managerに異常がないか確認してください。JP1/AJS3 - Manager での処理に時間が掛かっている場合もあるため，要求が反映されているかどうかを確認してください。

ほかのプログラムが使用しているポートに接続している可能性があります。ポート番号の定義が接続先のポート番号（jp1ajs3cdinetd）と一致しているかどうかを確認してください。

なお，この応答待ち時間はJP1/AJS3 - SDKの環境設定ファイルで変更できます。環境設定ファイルについては，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」を参照してください。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK0403-E

The transmitted data could not be encoded. (文字コード)

送受信データのエンコードに失敗しました(文字コード)

送受信データのエンコードに失敗しました。

（S）

処理を中断します。

（O）

JP1/AJS3 - Managerの文字コードの設定が正しいかどうかを確認してください。環境設定ファイルに文字コードを定義している場合，接続先JP1/AJS3 - Managerの文字コードと一致しているかどうかを確認してください。

KNAK0405-E

Processing was interrupted because an error was detected in the received data.Confirm that the port number (サービス名) is the same at the connection destination. (maintenance information = 保守情報1, 保守情報2)

受信データに異常を検出したため，処理を中断します。ポート番号の定義が接続先のポート番号(サービス名)と一致しているかを確認してください 保守情報:保守情報1, 保守情報2

JP1/AJS3 - Managerから送られてきたデータにプロトコル上の不正なデータを検出しました。

（S）

処理を中断します。

（O）

ポート番号の定義が接続先のポート番号（サービス名）と一致しているかどうかを確認してください。

KNAK0409-E

Information (情報名) about the connection destination cannot be obtained. (maintenance information = 保守情報1, 保守情報2)

接続先の情報(情報名)を取得できませんでした 保守情報:保守情報1, 保守情報2

接続先の情報を取得できませんでした。

（S）

処理を中断します。

（O）

接続先のホストにJP1/AJS3 - Managerが正しくインストールされているかどうかを確認してください。

KNAK0410-E

Cannot connect to the connection destination host (ホスト名) or JP1/AJS3 service on the connection destination host. (detailed information = ポート番号, IPアドレス)

接続先ホスト(ホスト名)または接続先ホストのJP1/AJS3サービスに接続できません 詳細情報:ポート番号, IPアドレス

接続先ホストまたは接続先ホストのJP1/AJS3サービスに接続できません。次の原因が考えられます。

接続先ホストのJP1/AJS3サービスが起動していない。

ポート番号の定義が，接続先のポート番号（jp1ajs3cdinetd）と一致していない。

接続先ホストが起動していない。

接続先ホストがビジー状態である。

接続先ホストとネットワーク接続できる状態ではない。

接続先のJP1/Baseの設定で，物理ホストの受信側バインド方式がIPバインド方式になっている場合，物理ホスト，およびどの論理ホストにもバインドされていないIPアドレスで接続しようとしている。

TCP/IPのポートが枯渇している。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

接続先がビジー状態の場合は，接続をリトライすることで接続できる場合があります。接続リトライ回数はJP1/AJS3 - SDKの環境設定ファイルで変更できます。環境設定ファイルについては，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」を参照してください。

接続先ホストとネットワーク接続できる状態ではない場合は，接続先ホストとのネットワーク環境の確認をしてください。接続先ホストとの間にファイアウォールがある場合は，ファイアウォールの設定を確認してください。ファイアウォールの設定については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のJP1/AJS3 - Managerのファイアウォールの通過の設定について記載している個所を参照してください。

接続先の物理ホスト，およびどの論理ホストにもバインドされていないIPアドレスで接続しようとした場合は，バインドされたIPアドレスで接続するか，または接続先でjp1hosts情報を定義するなどして対処してください。jp1hosts情報の定義については，マニュアル「JP1/Base 運用ガイド」を参照してください。

TCP/IPのポートが枯渇している場合は，ポートの状態を確認し，TIME_WAIT状態のポートが少なくなるのを待ってからメソッドを再実行してください。ユーザーアプリケーションにおいてJP1/AJS3 - SDKのメソッドを短時間に大量に呼び出している場合は，メソッドの呼び出し回数を見直してください。ポートを使用するアプリケーションが多数起動しているなど，ユーザーアプリケーション以外に問題が考えられる場合は，同時に起動するアプリケーション数やTCP/IPのポートに関する設定を見直してください。

KNAK0411-E

Invalid data was detected. Confirm the setting for the Manager's character code-set. (文字コード)

不正なデータを検出しました。マネージャーの文字コードの設定を確認してください (文字コード)

文字コードの不正によって，JP1/AJS3 - SDKでは処理できない不正なデータを検出しました。

（S）

処理を中断します。

（O）

ログアウトしたあと，接続先のJP1/AJS3 - Managerの設定で次のことを確認してください。

JP1/AJS3 - Managerが稼働しているOSの文字コードと，JP1/AJS3 - Managerの文字コードの設定が一致しているか

JP1/AJS3 - Managerの文字コードの設定を途中で変更し，かつ変更前のデータが残っていないか

リモートジョブネットの定義で，実行先マネージャーとの文字コードが一致しているか

なお，このメッセージが表示されていない場合で，JP1/AJS3 - SDKのデータが文字化けしているときも，上記と同じ対処をしてください。

KNAK0412-E

Failed to resolve the host name.

ホストの名前解決に失敗しました

ホストの名前解決に失敗しました。

（S）

処理を中断します。

（O）

ホストの名前解決ができることを確認してください。

KNAK0414-I

ENUM_RECV:(受信情報)

ENUM_RECV:(受信情報)

JP1/AJS3 - Managerからデータを受信したことを通知するメッセージです。

（S）

JP1/AJS3 - Managerからデータを受信したことをログに出力しました。

KNAK0415-E

The request cannot be processed at the connected AJS.

接続先のAJSではその要求を処理することができません

接続したJP1/AJS3 - Managerのバージョンでは，JP1/AJS3 - SDKの要求がサポートされていません。次の原因が考えられます。

接続先にJP1/AJS3 - SDKの要求を満たすバージョンのJP1/AJS3 - Managerがインストールされていません。

接続したJP1/AJS3 - Managerが互換用ISAM構成にもかかわらず，cancelSearch，cancelGetSchedule，getJobnetSummary，またはgetJobnetReleaseInfoを実行しています。互換用ISAM構成のJP1/AJS3 - Managerに対して，cancelSearch，cancelGetSchedule，getJobnetSummary，またはgetJobnetReleaseInfoは実行できません。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK0418-I

CONNECT[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

CONNECT[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

JP1/AJS3 - Managerとの接続に成功したことを通知するメッセージです。

（S）

[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]で接続に成功したことをログに出力しました。

KNAK0419-I

SEND:(データ0)(データ1)(データ2)(データ3)

SEND:(データ0)(データ1)(データ2)(データ3)

JP1/AJS3 - Managerへデータを送信したことを通知するメッセージです。

（S）

JP1/AJS3 - Managerへデータを送信したことをログに出力しました。

KNAK0420-I

RECV:(データ0)(データ1)(データ2)(データ3)

RECV:(データ0)(データ1)(データ2)(データ3)

JP1/AJS3 - Managerからデータを受信したことを通知するメッセージです。

（S）

JP1/AJS3 - Managerからデータを受信したことをログに出力しました。

KNAK0421-I

CLOSE[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

CLOSE[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

JP1/AJS3 - Managerとの接続をクローズしたことを通知するメッセージです。

（S）

[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]の接続をクローズしたことをログに出力しました。

KNAK0422-W

CLOSE ERR(保守情報)[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

CLOSE ERR(保守情報)[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]

JP1/AJS3 - Managerとの接続のクローズに失敗したことを通知するメッセージです。

（S）

[F(接続先IPアドレス, 接続先ポート番号) L(接続元IPアドレス, 接続元ポート番号)]の接続のクローズに失敗したことをログに出力しました。

KNAK0423-W

WARNNIG:保守情報

WARNNIG:保守情報

続行できるエラーが発生したことを通知するメッセージです。

（S）

続行できるエラーが発生したことをログに出力しました。

KNAK0424-E

MANAGER_ERR:保守情報/保守情報

MANAGER_ERR:保守情報/保守情報

JP1/AJS3 - Managerからエラー応答があったときに，その詳細を通知するメッセージです。

（S）

JP1/AJS3 - Managerのエラー応答の詳細をログに出力しました。

KNAK0426-E

SESSION_ERR:保守情報/保守情報/保守情報

SESSION_ERR:保守情報/保守情報/保守情報

接続先からエラー応答があったときに，その詳細を通知するメッセージです。

（S）

接続先のエラー応答の詳細をログに出力しました。

KNAK0427-I

REQ_START:(データ0)

REQ_START:(データ0)

JP1/AJS3 - Managerへの要求送信処理が開始したことを通知するメッセージです。

（S）

JP1/AJS3 - Managerへの要求送信処理が開始したことをログに出力しました。

KNAK0428-I

REQ_END:(データ0)

REQ_END:(データ0)

JP1/AJS3 - SDKからJP1/AJS3 - Managerへの要求が正常に実行されたことを通知するメッセージです。

（S）

JP1/AJS3 - Managerから正常な応答が返り，JP1/AJS3 - SDKからJP1/AJS3 - Managerへの要求が正常に実行されたことをログに出力しました。

KNAK0433-I

SDUMP:(データ0)

SDUMP:(データ0)

送信データを通知するメッセージです。

（S）

送信データをログに出力しました。

KNAK0434-I

RDUMP:(データ0)

RDUMP:(データ0)

受信データを通知するメッセージです。

（S）

受信データをログに出力しました。

KNAK0435-I

THROW CLIENT_EXCEPTION((例外名))

THROW CLIENT_EXCEPTION((例外名))

通信エラーやJP1/AJS3 - Managerからエラーが発生したなどの理由で，JP1/AJS3 - SDKからJP1/AJS3 - Managerへの要求が実行されなかったことを通知するメッセージです。

（S）

通信エラーやJP1/AJS3 - Managerからエラーが発生したなどの理由で，JP1/AJS3 - SDKからJP1/AJS3 - Managerへの要求が実行されなかったことをログに出力しました。

KNAK0438-I

ER_SDUMP:(データ0)

ER_SDUMP:(データ0)

JP1/AJS3 - Managerでエラーが発生したときや，通信エラーが発生したときなどに，送信したデータを通知するメッセージです。

（S）

JP1/AJS3 - Managerでエラーが発生したときや，通信エラーが発生したときなどに送信したデータをログに出力しました。

KNAK0440-I

ER_RDUMP:(データ0)

ER_RDUMP:(データ0)

通信エラーが発生した場合などに，途中まで受信したデータを通知するメッセージです。

（S）

通信エラーが発生した場合などに，途中まで受信したデータをログに出力しました。

KNAK0441-E

ENCODE_ERR:文字コード:保守情報

ENCODE_ERR:文字コード:保守情報

サポートしていない文字コードが指定されているため，データを文字列に変換できなかったことを通知するメッセージです。

（S）

サポートしていない文字コードが指定されているため，データを文字列に変換できなかったことをログに出力しました。

KNAK0442-E

CONNECT_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

CONNECT_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

接続時にエラーが発生したことや，接続の途中で接続が切断されたことを通知するメッセージです。ただし，接続時にエラーが発生した場合は，L(接続元IPアドレス, 接続元ポート番号)は表示されません。

（S）

接続に失敗したことをログに出力しました。

（O）

このメッセージは内部ログであるため，対処は不要です。

KNAK0443-E

SEND_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

SEND_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

データの送信に失敗したことを通知するメッセージです。

（S）

データの送信に失敗したことをログに出力しました。

（O）

このメッセージは内部ログであるため，対処は不要です。

KNAK0444-E

RECV_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

RECV_ERR(保守情報/保守情報)[L(接続元IPアドレス, 接続元ポート番号) F(接続先IPアドレス, 接続先ポート番号)]

データの受信に失敗したことを通知するメッセージです。

（S）

データの受信に失敗したことをログに出力しました。

（O）

このメッセージは内部ログであるため，対処は不要です。

KNAK0448-W

LOGIN FAILURE WAITING ERR (maintenance information = 保守情報)

LOGIN FAILURE WAITING ERR保守情報:保守情報

ログインの処理待ちに失敗したことを通知するメッセージです。

（S）

ログインの処理待ちに失敗したことをログに出力しました。

KNAK0450-E

An error occurred in session processing. (maintenance information = 保守情報1, 保守情報2)

セション処理でエラーが発生しました 保守情報:保守情報1, 保守情報2

JP1/AJS3 - SDKから送信したデータに不正がありました。または，JP1/AJS3 - Managerから予期しない応答がありました。

（S）

処理を中断します。

（O）

次の資料を採取したあと，システム管理者に連絡してださい。

JP1/AJS3 - SDKのログ情報

JP1/AJS3 - Managerのログ情報

JP1/AJS3 - SDKのログ情報の採取方法については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のトラブル発生時に採取が必要な資料について記載している個所を参照してください。

JP1/AJS3 - Managerのログ情報の採取方法については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のトラブル発生時に採取が必要な資料について記載している個所を参照してください。

KNAK0451-E

The JP1/AJS3 service at the connection destination has not been started. (maintenance information = 保守情報1, 保守情報2)

接続先のJP1/AJS3サービスが未起動です 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3サービスが未起動です。次の原因が考えられます。

接続先でJP1/AJS3サービスが起動していない。

接続先のJP1/Baseの設定で物理ホストに対して受信側バインド方式がIPバインド方式になっている場合，物理ホスト，およびどの論理ホストにもバインドされていないIPアドレスで接続しようとした。

接続先がUNIXの場合，接続先でJP1/AJS3 - Managerの構成変更時にajsshmdelコマンドを実行していない，またはすべてのJP1/AJS3のサービスを停止しないで，ajsshmdelコマンドを実行した。

接続先がWindowsの場合，接続先でJP1/AJS3 - Managerの構成変更時にすべてのJP1/AJS3のサービスを停止しなかった。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

接続先の物理ホスト，およびどの論理ホストにもバインドされていないIPアドレスで接続しようとした場合は，バインドされたIPアドレスで接続するか，または接続先でjp1hosts情報を定義するなどで対処してください。jp1hosts情報の定義については，マニュアル「JP1/Base 運用ガイド」を参照してください。

接続先でのJP1/AJS3 - Managerの構成変更時の作業が原因の場合は，接続先で次の手順に従って対処をしてください。

動作中のJP1/AJS3のすべてのプロセス（サービス，コマンドなど）を停止する。

接続先がWindowsの場合は，手順3に進んでください。

接続先がUNIXの場合は，手順2に進んでください。

ajsshmdelコマンドを実行する。

JP1/AJS3を再起動する。

KNAK0452-E

Cannot connect because the number of connections exceeded the maximum. (maintenance information = 保守情報1, 保守情報2)

接続数が最大値を超えたため接続できません 保守情報:保守情報1, 保守情報2

JP1/AJS3 - Managerとの接続数が最大値を超えたため接続できません。

（S）

処理を中断します。

（O）

該当するJP1/AJS3 - Managerの接続が解放されるまで，しばらく待ってから再実行してください。それでも再接続できない場合は，該当するJP1/AJS3 - Manager上で接続を強制解放してください。

このエラーが頻繁に発生する場合は，最大接続数の設定を見直してください。

ほかに接続されていないにもかかわらず，このメッセージが表示される場合は，接続先でJP1/AJS3 - Managerのセットアップが正しく行われているかどうかを確認してください。

KNAK0453-E

The specified scheduler service does not exist. (maintenance information = 保守情報1, 保守情報2)

指定したスケジューラーサービスは存在しません 保守情報:保守情報1, 保守情報2

指定したスケジューラーサービスはありません。次の原因が考えられます。

メソッドで指定しているスケジューラーサービスが接続先のJP1/AJS3 - Managerにない。

接続先のJP1/AJS3 - Managerがクラスタ構成，かつ論理ホストにログインした場合でも，すべてのスケジューラーサービスを表示させているとき，ログインした論理ホスト外のスケジューラーサービスにアクセスした。

（S）

処理を中断します。

（O）

スケジューラーサービス一覧メソッドを呼び出すなどにより，最新の情報で，スケジューラーサービスが存在しているかどうかを確認したあと，正しいスケジューラーサービス名を指定してメソッドを呼び出してください。

KNAK0454-E

The user could not be authenticated at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でユーザー認証に失敗しました 保守情報:保守情報1, 保守情報2

接続先でユーザー認証に失敗しました。

（S）

処理を中断します。

（O）

次の資料を採取したあと，システム管理者に連絡してください。

JP1/AJS3 - SDKのログ情報

接続先のJP1/AJS3 - Managerのログ情報

JP1/Baseのログ情報（認証サーバが別のホストにある場合は，認証サーバ側のJP1/Baseのログ情報も含みます）

JP1/AJS3 - SDKのログ情報の採取方法については，マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のトラブル発生時に採取が必要な資料について記載している個所を参照してください。

JP1/AJS3 - Managerのログ情報の採取方法については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のトラブル発生時に採取が必要な資料について記載している個所を参照してください。

JP1/Baseのログ情報の採取方法については，マニュアル「JP1/Base 運用ガイド」のトラブル発生時に採取が必要な資料について記載している個所を参照してください。

KNAK0455-E

The request cannot be processed at the connected AJS. (maintenance information = 保守情報1, 保守情報2)

接続先のAJSではその要求を処理することができません 保守情報:保守情報1, 保守情報2

接続したJP1/AJS3 - Manager のバージョンでは，JP1/AJS3 - SDKの要求がサポートされていません。

（S）

処理を中断します。

（O）

ほかのプログラムが使用しているポートに接続している可能性があります。

環境設定ファイルのport_numberに指定した値が接続先のポート番号（jp1ajs3cdinetd）と一致しているかを確認してください。

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK0457-E

The user name or password is invalid. (maintenance information = 保守情報1, 保守情報2)

ユーザー名かパスワードに誤りがあります 保守情報:保守情報1, 保守情報2

JP1ユーザー名かパスワードに誤りがあったため，ログインできませんでした。

（S）

処理を中断します。

（O）

接続先の認証サーバで登録されている，JP1ユーザー名とパスワードを入力して，ログインしてください。

KNAK0458-E

User mapping failed. The user was not associated with an OS user at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でユーザーマッピングに失敗しました 保守情報:保守情報1, 保守情報2

接続先でユーザーマッピングに失敗しました。次の原因が考えられます。

接続先のJP1/Baseのユーザーマッピングの設定で，JP1ユーザー名とOSユーザー名がマッピング定義されていない。

接続先のJP1/Baseのユーザーマッピングの設定で，JP1ユーザー名とマッピングしているOSユーザーがOSの設定で削除されているか，またはパスワードが変更されている。

接続先のJP1/Baseのユーザーマッピングの設定で，JP1ユーザー名とマッピングしているOSユーザーのユーザーIDまたはグループIDが不正な値である。

接続先のJP1/Baseのパスワード管理の設定で，JP1ユーザー名とマッピングするOSユーザーが登録されていない。

接続先のJP1/Baseのパスワード管理の設定で，JP1ユーザー名とマッピングするOSユーザーのアカウントがロックアウトされている。

接続先のJP1/Baseのユーザーマッピングの設定で，サーバホスト名に自ホスト名を指定していないか，または誤って指定している。

自ホスト名の指定方法に関する注意事項については，マニュアル「JP1/Base 運用ガイド」のユーザーマッピングの設定について記載している個所を参照してください。

ユーザーマッピング時にメモリー不足が発生した。

（S）

処理を中断します。

（O）

エラーの原因となったAPIに応じて，次の対処を行ってください。

ログインのAPIでエラーになった場合

エラーの原因を取り除いて再度ログインしてください。

ログイン以外のAPIでエラーになった場合

いったんログアウトし，エラーの原因を取り除いたあとで再度ログインしてください。

KNAK0459-E

An error occurred in the Access Control Server at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先の認証サーバでエラーが発生しました 保守情報:保守情報1, 保守情報2

ユーザー認証処理中に接続先のJP1/Baseでエラーが発生したため，ログイン，または接続できませんでした。次の原因が考えられます。

接続先のJP1/Baseの設定で認証サーバのホスト名を誤って指定している。

接続先のWindowsイベントログ，またはsyslogで，エラーメッセージ「KAVS1005-E 認証サーバに接続できません」が表示されている場合は，認証サーバが起動していない。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

接続先がUNIXで，認証サーバを自ホストに指定している場合は，JP1/Baseを認証サーバとして起動する設定が必要です。設定方法については，マニュアル「JP1/Base 運用ガイド」の認証サーバの指定について記載している個所を参照してください。

KNAK0460-E

You cannot use the current login information to log in.

現在のログイン情報ではログインできません

JP1/AJS3 - SDKのログイン処理中に認証サーバが再起動したため，現在のログイン情報でログインできませんでした。

（S）

処理を中断します。

（O）

再度ログインしてください。

KNAK0461-E

The connection is not possible because the specified scheduler service is under maintenance. (maintenance information = 保守情報1, 保守情報2)

指定したスケジューラーサービスはメンテナンス中のため接続できません 保守情報:保守情報1, 保守情報2

対象スケジューラーサービスはメンテナンス中のためアクセスできません。

（S）

処理を中断します。

（O）

対象スケジューラーサービスのメンテナンスの終了を確認したあと，再度操作してください。

KNAK0463-E

Connection denied. (maintenance information = 保守情報1, 保守情報2)

接続が拒否されました 保守情報:保守情報1, 保守情報2

接続先JP1/AJS3 - Managerの接続許可設定ファイルに接続元JP1/AJS3 - SDKのホストが登録されていないため，JP1/AJS3 - Managerに接続できませんでした。

（S）

処理を中断します。

（O）

接続先JP1/AJS3 - Managerの統合トレースログに出力されているKAVS8040-Eメッセージの対処方法に従ってください。

5.3.5　KNAK0501〜KNAK1000

APIの接続先（JP1/AJS3 - Manager）に関するエラーのメッセージの一覧を次に示します。

KNAK0501-E

An error occurred at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でエラーが発生しました 保守情報:保守情報1, 保守情報2

接続先でエラーが発生しました。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - ManagerのホストにあるWindowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。

ログファイルの内容とログ情報については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

また，このメッセージの保守情報1が0で，接続先のJP1/AJS3 - ManagerがUNIXの場合は，ログインするJP1ユーザーにマッピングされているOSユーザーのホームディレクトリがあるかどうかを確認し，ない場合は作成してください。

KNAK0502-E

The specified unit does not exist. (maintenance information = 保守情報1, 保守情報2)

指定されたユニットは存在しません 保守情報:保守情報1, 保守情報2

指定されたユニットはありません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットが削除されていないことを確認してください。

KNAK0507-E

A past date is specified for an execution start day. (maintenance information = 保守情報1, 保守情報2)

実行開始日時に過去の日付が指定されています 保守情報:保守情報1, 保守情報2

メソッドの実行に失敗しました。次の原因が考えられます。

確定実行登録時の確定期間の開始日に過去の日付が指定された

実行予定追加時の開始時刻に過去の日付が指定された

日時変更時の開始日時に過去の日付が指定された

（S）

処理を中断します。

（O）

実行開始日時に現在以降の日付を指定したあと，メソッドを再実行してください。

KNAK0508-E

Cannot treat as Jobnet. (maintenance information = 保守情報1, 保守情報2)

ジョブネットとして扱えません 保守情報:保守情報1, 保守情報2

指定されたユニットは，ジョブネットとして扱えません。リカバリー属性を持つルートジョブネットを実行登録したことが考えられます。

（S）

処理を中断します。

（O）

ジョブネットの定義内容が誤っていないかどうかを確認してください。実行登録時はルートジョブネットがリカバリー属性を持っていないかどうかを確認してください。

KNAK0509-E

It has no schedule. (maintenance information = 保守情報1, 保守情報2)

予定がありません 保守情報:保守情報1, 保守情報2

次回実行予定のないジョブネットに対して，計画一時変更を行いました。

（S）

処理を中断します。

（O）

該当するジョブネットの状態を確認したあと，メソッドを再実行してください。

KNAK0510-E

Cannot treat as Unit. (maintenance information = 保守情報1, 保守情報2)

ユニットとして扱えません 保守情報:保守情報1, 保守情報2

指定されたユニットは，ユニットとして扱えません。または，ユニットがありません。処理対象のユニットがほかで削除されたことが考えられます。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，操作対象のユニットが存在するかどうかを確認してください。

KNAK0513-E

Cannot be registered because the limit on registered jobnet has been exceeded. (maintenance information = 保守情報1, 保守情報2)

登録可能なジョブネット数が限界値を超えたため，登録できません 保守情報:保守情報1, 保守情報2

登録できるジョブネットの数が限界値を超えたため，登録できません。

（S）

処理を中断します。

（O）

不要なジョブネットの登録を解除したあと，再度実行登録してください。

登録できるジョブネットの最大数は2,147,483,647です。

KNAK0520-E

Jobnet already registered. (maintenance information = 保守情報1, 保守情報2)

ジョブネットはすでに登録されています 保守情報:保守情報1, 保守情報2

登録中のジョブネットに対して，実行できないメソッドが呼び出されました。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットがすでに登録されているかどうかを確認してください。登録されている場合，必要であれば登録解除したあとに，メソッドを再実行してください。

KNAK0521-E

Specified jobnet is not registered. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットは登録されていません 保守情報:保守情報1, 保守情報2

未登録のジョブネットに対して実行できないメソッドが呼び出されました。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットが未登録かどうかを確認してください。未登録の場合，実行登録したあと，メソッドを再実行してください。

KNAK0522-E

The specified job or jobnet is being executed. (maintenance information = 保守情報1, 保守情報2)

指定したジョブまたはジョブネットは実行中です 保守情報:保守情報1, 保守情報2

実行中のジョブ，またはジョブネットに対して実行できないメソッドが呼び出されました。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットが実行中かどうかを確認してください。実行中の場合，実行が終了したあと，メソッドを再実行してください。

KNAK0523-E

The specified job or jobnet has no schedule to be executed. (maintenance information = 保守情報1, 保守情報2)

指定したジョブまたはジョブネットには実行予定がありません 保守情報:保守情報1, 保守情報2

指定したジョブ，またはジョブネットには実行予定がありません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，操作対象世代を確認してください。

KNAK0524-E

Cannot change the schedule temporarily because the execution start day of the specified jobnet differs from that of the upper jobnet. (maintenance information= 保守情報1, 保守情報2)

指定したジョブネットの実行開始日時が上位ジョブネットと異なるため計画一時変更ができません 保守情報:保守情報1, 保守情報2

指定したジョブネットの実行開始日時がルートジョブネットの実行開始日の基準時刻から48時間の範囲内でないため計画一時変更ができません。

（S）

処理を中断します。

（O）

計画一時変更時に指定する実行開始日時には，ルートジョブネットの実行開始日の基準時刻から48時間の範囲内で指定してください。

KNAK0525-E

The date has not been changed or the execution has not been stopped. (maintenance information = 保守情報1, 保守情報2)

日時変更または実行中止が行われていません 保守情報:保守情報1, 保守情報2

日時変更，または実行中止が行われていません。

（S）

処理を中断します。

（O）

操作対象となる予定に誤りがないかを確認してください。

KNAK0526-E

Cannot execute the method - wait for start condition. (maintenance information = 保守情報1, 保守情報2)

起動条件待ちのためメソッドは実行できません 保守情報:保守情報1, 保守情報2

起動条件待ちのためメソッドは実行できません。

（S）

処理を中断します。

（O）

起動条件が成立したあと，メソッドを再実行してください。

KNAK0527-E

Cannot execute the method - Jobnet has been shutdown. (maintenance information = 保守情報1, 保守情報2)

閉塞中のためメソッドは実行できません 保守情報:保守情報1, 保守情報2

閉塞中のためメソッドは実行できません。次の原因が考えられます。

カレンダー参照先ジョブグループがない。

排他スケジュールで指定したユニットが同一階層にない。

（S）

処理を中断します。

（O）

閉塞した原因を取り除いたあと，閉塞したジョブネットを登録解除してください。必要に応じて再度実行登録してください。

KNAK0532-E

The jobnet cannot be registered because no effective start day is defined. (maintenance information = 保守情報1, 保守情報2)

有効な開始日定義が無いため，ジョブネットは登録できません 保守情報:保守情報1, 保守情報2

スケジュール情報の定義で有効な開始日時が定義されていないため，登録できません。次の原因が考えられます。

登録日が有効期日を過ぎている。

確定実行登録時に確定期間の開始日が実行開始日よりあとになっている。

スケジュール定義で開始日が有効期日を過ぎている。

登録日時が開始日時を過ぎているにもかかわらず，スケジュール定義で処理サイクルを指定していない。

スケジュール定義で開始日時が休業日であるにもかかわらず，休業日振り替えを「実行しない」にして処理サイクルを指定していない。

（S）

処理を中断します。

（O）

実行登録時の指定を正しく指定したあと，再度実行登録してください。

KNAK0533-E

The jobnet cannot be registered because no schedule is defined. (maintenance information = 保守情報1, 保守情報2)

スケジュール定義が未定義なため，ジョブネットは登録できません 保守情報:保守情報1, 保守情報2

スケジュール情報の定義がされていないため登録できません。

（S）

処理を中断します。

（O）

スケジュールルールを作成したあと，再度実行登録してください。

KNAK0534-E

There is no execution schedule in the specified period. (maintenance information = 保守情報1, 保守情報2)

指定した期間に実行予定はありません 保守情報:保守情報1, 保守情報2

指定された期間に実行予定がありません。

（S）

処理を中断します。

（O）

スケジュール情報の設定を確認してください。

KNAK0535-E

The jobnet cannot be registered because the exclusive jobnet is invalid. (maintenance information = 保守情報1, 保守情報2)

排他ジョブネットに誤りがあるため，ジョブネットは登録できません 保守情報:保守情報1, 保守情報2

排他ジョブネットの設定に誤りがあるため，登録できません。

（S）

処理を中断します。

（O）

排他ジョブネットに指定しているユニットが同一階層のジョブネット，またはプランニンググループかを確認し，正しく設定したあと，再度実行登録してください。

KNAK0536-E

The jobnet cannot be registered because the calendar information is invalid. (maintenance information = 保守情報1, 保守情報2)

カレンダー情報に誤りがあるため，ジョブネットは登録できません 保守情報:保守情報1, 保守情報2

カレンダー情報に誤りがあるため，登録できません。

（S）

処理を中断します。

（O）

カレンダー参照先ジョブグループがあるかどうかを確認し，正しいジョブグループを指定したあと，再度実行登録してください。

KNAK0537-E

The specified unit has neither a forecast nor performance. (maintenance information = 保守情報1, 保守情報2)

指定されたユニットの予実績はありません 保守情報:保守情報1, 保守情報2

指定されたユニットの予実績がありません。

（S）

処理を中断します。

（O）

予定または結果があるユニットを選択してください。

KNAK0538-E

Specified execution ID was not found. (maintenance information = 保守情報1, 保守情報2)

指定した実行IDは登録されていません 保守情報:保守情報1, 保守情報2

操作対象の実行IDがないため処理できません。次の原因が考えられます。

操作対象世代が保存世代数を超えた。

操作対象世代が期間指定で登録解除された。

対象ジョブネットが登録解除されたあと，再度実行登録された。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，正しい実行IDを指定してメソッドを再実行してください。

KNAK0539-E

The specified jobnet does not exist. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットは存在しません 保守情報:保守情報1, 保守情報2

指定されたジョブネットはありません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ジョブネットが存在するかどうかを確認したあと，メソッドを再実行してください。

KNAK0540-E

Specified Jobnet is not executing. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットは実行中ではありません 保守情報:保守情報1, 保守情報2

指定されたジョブネットは実行中でないため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ジョブネットの状態を確認してください。

KNAK0541-E

Specified Job is not executing. (maintenance information = 保守情報1, 保守情報2)

指定したジョブは実行中ではありません 保守情報:保守情報1, 保守情報2

指定されたジョブは実行中でないため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ジョブの状態を確認してください。

KNAK0542-E

Memory became insufficient at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でメモリ不足が発生しました 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerでメモリー不足が発生しました。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - Managerが，メモリー不足の発生する状態になっていないかどうかを確認してください。

KNAK0543-E

There is insufficient space for the file at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でファイルの空き容量がありません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerでファイルを書き込もうとしているファイルシステム，またはデバイスに空き容量がありません。

（S）

処理を中断します。

（O）

接続先の不要なファイルを削除して，空き容量を作成してください。

また，接続のJP1/AJS3 - Managerが使用するデータベースの表領域，またはRDAREAに空きがあるかどうかを確認し，空きがない場合は，マニュアル「JP1/Automatic Job Management System 3 運用ガイド」のデータベースの再編成について記載している個所を参照して，空き領域を作成してください。

KNAK0544-E

The specified unit is being used elsewhere. (maintenance information = 保守情報1, 保守情報2)

指定したユニットは他で使用中です 保守情報:保守情報1, 保守情報2

ほかのユーザーがユニットを使用中のため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

JP1/AJS3 - Managerに接続しているすべてのJP1/AJS3 - SDK，およびJP1/AJS3 - Viewで，ユニットが使用中かどうかを確認してください。

JP1/AJS3 - SDK，およびJP1/AJS3 - Viewの接続情報を確認するには，接続先のJP1/AJS3 - Manager で，ajsstatusコマンドに-cオプション，または-vオプションを指定して実行してください。

なお，通信エラーによってJP1/AJS3 - SDK，およびJP1/AJS3 - Viewの接続が切れると，接続していないにもかかわらず接続状態が残り，ユニットが使用中となる場合があります。この場合，不正に残っている接続状態が打ち切られるのを待ち，JP1/AJS3 - Managerで接続状態が残ってないことを確認してから，再度操作してください。接続先のJP1/AJS3 - Managerの環境設定パラメーターCDSESSIONTIMEOUTを指定することで，JP1/AJS3 - SDKの接続を打ち切るまでの時間を短くできます。CDSESSIONTIMEOUTのデフォルト値は「dword:00000003」（10進数で3）（単位：分）です。環境設定パラメーターの詳細については，マニュアル「JP1/Automatic Job Management System 3 構築ガイド2」を参照してください。

KNAK0545-E

No authorization. (maintenance information = 保守情報1, 保守情報2)

権限がありません 保守情報:保守情報1, 保守情報2

JP1/AJS3サービス，およびJP1ユーザーにマッピングされたOSユーザーに必要な権限がないために処理できません。

（S）

処理を中断します。

（O）

次の原因が考えられます。該当する原因を取り除いてください。

接続先がWindows版のJP1/AJS3 - Managerの場合

JP1/AJS3サービスをユーザーアカウントで運用している場合，そのユーザーアカウントが必要な権限を持っていない。

必要な権限については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（システム構築編）」のJP1/AJS3のサービスの設定を変更する必要がある場合について記載している個所を参照してください。

JP1/Baseのユーザーマッピングの設定で，ログインしたJP1ユーザーにマッピングするOSユーザーの定義形式に誤りがある。

OSユーザーの定義形式については，マニュアル「JP1/Automatic Job Management System 3 構築ガイド1」のJP1/Baseのセットアップについて記載している個所を参照してください。

スケジューラーサービスのデータベースディレクトリ名で指定したフォルダと，その下にあるファイルに対して，JP1ユーザーにマッピングされたOSユーザーの読み取り，および書き込み権限が設定されていない。

接続先がUNIX版のJP1/AJS3 - Managerの場合

JP1ユーザーにマッピングされたOS ユーザーが構成定義ファイル（/opt/jp1/hcclibcnf/regdir以下のファイル）を読み込む権限を持っていない。

スケジューラーサービスのデータベースディレクトリ名で指定したディレクトリと，その下にあるファイルに対して，JP1ユーザーにマッピングされたOS ユーザーの更新権限（rwx）が設定されていない。

KNAK0546-E

You are not authorized to operate those jobs. (maintenance information = 保守情報1, 保守情報2)

ジョブの操作権限がありません 保守情報:保守情報1, 保守情報2

呼び出されたメソッドを実行する権限がありません。

（S）

処理を中断します。

（O）

ユーザーの権限を確認してください。

KNAK0547-E

Only the superuser can perform that process. (maintenance information = 保守情報1, 保守情報2)

特権管理者でなければ操作できません 保守情報:保守情報1, 保守情報2

呼び出されたメソッドを実行する権限がありません。

（S）

処理を中断します。

（O）

ユーザーの権限を確認してください。

KNAK0548-E

No authority for Specified Unit. (maintenance information = 保守情報1, 保守情報2)

指定したユニットへの権限がありません 保守情報:保守情報1, 保守情報2

指定されたユニットに対して，メソッドを実行する権限がありません。

（S）

処理を中断します。

（O）

JP1ユーザーの権限を確認してください。

KNAK0549-E

The specified scheduler service is not running. (maintenance information = 保守情報1, 保守情報2)

指定したスケジューラーサービスは起動していません 保守情報:保守情報1, 保守情報2

操作対象のユニットが属するスケジューラーサービスが起動されていないため，メソッドを実行できません。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - Manager で操作対象のスケジューラーサービスを起動してください。

KNAK0550-E

An error occurred during the accessing of the database at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でデータベースのアクセス中にエラーが発生しました 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Manager でデータベースアクセス中にエラーが発生しました。

（S）

処理を中断します。

（O）

JP1/AJS3 - Managerのホストにある，Windowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。

ログファイルの内容とログ情報については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

KNAK0551-E

Resources became insufficient at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でリソース不足が発生しました 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Manager でリソース不足が発生しました。

（S）

処理を中断します。

（O）

JP1/AJS3 - Managerのホストにある，Windowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。

ログファイルの内容とログ情報については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

KNAK0554-E

At the connection destination, a required file cannot be accessed. (maintenance information = 保守情報1, 保守情報2)

接続先で必要なファイルにアクセスできません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで必要なファイルが見つからない，またはアクセスできません。

（S）

処理を中断します。

（O）

接続先でロックファイルやISAMファイルがあるかどうかを確認して，セマフォや共有メモリーなどのカーネルパラメーターを見直してください。

また，JP1/AJS3 - Managerのホストにある，Windowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。

ログファイルの内容とログ情報については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

KNAK0555-E

The unit is not in a re-executable status. (maintenance information = 保守情報1, 保守情報2)

再実行可能な状態ではありません 保守情報:保守情報1, 保守情報2

指定されたユニットは，再実行できる状態ではありません。次の原因が考えられます。

実行されていないジョブネットを再実行した。

実行中のルートジョブネットに対して，保留オプションを指定して再実行した。

実行中であり，かつリモートジョブネットのルートジョブネットを再実行した。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットの状態を確認したあと，メソッドを再実行してください。

KNAK0556-E

The method cannot be executed for the specified unit. (maintenance information = 保守情報1, 保守情報2)

指定されたユニットに対してメソッドを実行できません 保守情報:保守情報1, 保守情報2

指定されたユニットに対してメソッドを実行できません。次の原因が考えられます。

指定したユニットが削除されたため見つからない。

起動条件中のユニットを指定している。

指定したユニットが属するスケジューラーサービスに対して参照権限がない。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，操作対象のユニットが存在するかどうか，起動条件中（起動条件も含む）のユニットを指定していないかどうか，JP1ユーザーに権限があるかどうかを確認してください。

KNAK0557-E

File processing count exceeds the limit at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で処理できるファイル数の上限を超えました 保守情報:保守情報1, 保守情報2

接続先で処理できるファイル数の制限値を超えました。

（S）

処理を中断します。

（O）

接続先で不要なウィンドウやダイアログボックスを閉じたあと，メソッドを再実行してください。

接続先がUNIXの場合はリリースノートを参照し，カーネルパラメーターの次の項目を確認してください。

プロセスやシステムの最大ファイルオープン数

最大ファイル記述子数（ファイルシステムにかかわる制限値）

KNAK0558-E

Lock resources count exceeds the limit at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で処理できるロック資源数の上限を超えました 保守情報:保守情報1, 保守情報2

接続先で処理できるロック資源数の制限値を超えました。

（S）

処理を中断します。

（O）

接続先で不要なウィンドウやダイアログボックスを閉じたあと，メソッドを再実行してください。

接続先がUNIXの場合は，リリースノートを参照し，カーネルパラメーターの次の項目を確認してください。

プロセスやシステムの最大ファイルオープン数

最大ファイル記述子数（ファイルシステムにかかわる制限値）

KNAK0559-E

Not enough space in file system at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先のファイルシステムに十分な領域がありません 保守情報:保守情報1, 保守情報2

接続先のファイルシステムに十分な領域がありません。

（S）

処理を中断します。

（O）

接続先で不要なウィンドウやダイアログボックスを閉じ，不要なファイルを削除した上で，使用できる領域を確保したあと，メソッドを再実行してください。

接続先がUNIXの場合は，リリースノートを参照し，カーネルパラメーターの次の項目を確認してください。

プロセスやシステムの最大ファイルオープン数

最大ファイル記述子数（ファイルシステムにかかわる制限値）

KNAK0560-E

System resources became insufficient at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でシステムリソース不足が発生しました 保守情報:保守情報1, 保守情報2

接続先でシステムリソース不足が発生しました。

（S）

処理を中断します。

（O）

接続先で不要なウィンドウやダイアログボックスを閉じたあと，メソッドを再実行してください。

接続先がUNIXの場合は，リリースノートを参照し，カーネルパラメーターの次の項目を確認してください。

プロセスやシステムの最大ファイルオープン数

最大ファイル記述子数（ファイルシステムにかかわる制限値）

KNAK0561-E

Shared memory is not available at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で共有メモリが確保できません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで，システムリソースの一つである共有メモリーが取得できないか，または必要な共有メモリーがありません。

（S）

処理を中断します。

（O）

リリースノートを参照し，接続先でシステムの共有メモリーの見積もりが正しいかどうかを確認したあと，カーネルパラメーターを拡大してください。

また，スケジューラーサービスの稼働に必要な共有メモリーが削除された場合は，スケジューラーサービスを再起動してください。

KNAK0563-E

Cannot obtain configuration definition at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で構成定義情報が取得できませんでした 保守情報:保守情報1, 保守情報2

接続先で構成定義情報が取得できませんでした。

（S）

処理を中断します。

（O）

JP1/AJS3 - Managerのホストにある，Windowsイベントログ，またはsyslogなどのログ情報を参照して調査してください。そのあと，調査結果に基づいてエラー要因を取り除いてください。

ログファイルの内容とログ情報については，マニュアル「JP1/Automatic Job Management System 3 トラブルシューティング」のログの種類とログ情報の格納先について記載している個所を参照してください。

KNAK0564-E

Cannot add because the execution start date of the specified jobnet differs from that of the upper jobnet. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットの実行開始日時が上位ジョブネットと異なるため追加ができません 保守情報:保守情報1, 保守情報2

指定したジョブネットの実行開始日時が，ルートジョブネットの実行開始日の基準時刻から48時間の範囲内でないため追加ができません。

（S）

処理を中断します。

（O）

追加時に指定する実行開始日時は，ルートジョブネットの実行開始日の基準時刻から48時間の範囲内で指定してください。

KNAK0566-E

The date is specified incorrectly. (maintenance information = 保守情報1, 保守情報2)

日付の指定に誤りがあります 保守情報:保守情報1, 保守情報2

日付を誤って指定しています。

（S）

処理を中断します。

（O）

日付を正しく指定してください。

KNAK0568-E

The method that was called cannot be executed for the specified unit's status. (maintenance information = 保守情報1, 保守情報2)

呼び出されたメソッドは指定したユニットの状態に対して実行できません 保守情報:保守情報1, 保守情報2

指定したユニットの状態に対して，実行できないメソッドが呼び出されました。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，指定したユニットの状態を確認してください。

ジョブ状態変更時にこのメッセージが表示された場合は，マニュアル「JP1/Automatic Job Management System 3 コマンドリファレンス1」のajschgstatコマンドについて記載している個所を参照し，現在の状態に対して変更後に指定した状態に誤りがないかどうか，終了コードは変更できるかを確認してください。

KNAK0569-E

Cannot hold rerun - specified Jobnet already running. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットは実行中のため保留再実行できません 保守情報:保守情報1, 保守情報2

実行中のジョブネットは保留再実行できません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，指定したユニットの状態を確認してください。

KNAK0570-E

Specified Unit cannot rerun. (maintenance information = 保守情報1, 保守情報2)

指定したユニットは再実行できません 保守情報:保守情報1, 保守情報2

指定したユニットは再実行できるユニットおよび状態ではありません。次の原因が考えられます。

再実行しようとしたネストジョブネットまたはジョブの状態が，実行中，異常検出実行中，警告検出実行中，先行終了待ち，開始時刻待ち，または保留中である。

再実行しようとしたネストジョブネットまたはジョブがリカバリー属性を持ち，先行のジョブネットまたはジョブの状態が，正常終了，または警告終了である。

再実行しようとしたネストジョブネットまたはジョブが，判定ジョブ，または判定ジョブの従属ユニットである。

再実行しようとしたネストジョブネットまたはジョブの上位ジョブネットにスケジュールがない。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，再実行しようとしたユニットのユニット種別または状態を確認してください。

KNAK0571-E

Cannot execute the method because it is being restrict-processed. (maintenance information = 保守情報1, 保守情報2)

制限処理中のためメソッドを実行できません 保守情報:保守情報1, 保守情報2

操作対象のユニットが属するスケジューラーサービスは制限処理中であるため，メソッドを実行できません。

（S）

処理を中断します。

（O）

接続先でajsstopコマンドにより対象となるスケジューラーサービスの制限を解除するか，スケジューラーサービスが再開したあと，メソッドを実行してください。

KNAK0572-E

The database files of the scheduler service do not exist. (maintenance information = 保守情報1, 保守情報2)

スケジューラーサービスのデータベースファイルが存在しません 保守情報:保守情報1, 保守情報2

指定したスケジューラーサービスのデータベースファイルがありません。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - Managerで，指定したスケジューラーサービスに対する環境設定内容，およびディスクのマウント状態を見直したあと，ファイルへアクセスできる状態にして再接続してください。

KNAK0573-E

You can perform fixed registration only, because the specified jobnet has a hostlink jobnet. (maintenance information = 保守情報1, 保守情報2)

指定したジョブネットにはホストリンクジョブネットが存在するため確定登録しかできません 保守情報:保守情報1, 保守情報2

ホストリンクジョブネットがあるジョブネットは，確定実行登録以外の実行登録はできません。

（S）

処理を中断します。

（O）

ホストリンクジョブネットがあるジョブネットに対して実行登録するときは，確定実行登録してください。

KNAK0574-E

You cannot execute the method because the hostlink jobnet is in a jobnet that has a start condition. (maintenance information = 保守情報1, 保守情報2)

起動条件付きのジョブネットにホストリンクジョブネットが含まれているためメソッドは実行できません 保守情報:保守情報1, 保守情報2

起動条件とホストリンクジョブネットが，混在するジョブネットに対して，実行登録できません。

または，サスペンド状態のホストリンクジョブネットを含むジョブネットに対して，起動条件が設定されたためサスペンドの解除はできません。

（S）

処理を中断します。

（O）

起動条件，またはホストリンクジョブネットを削除してから，再度操作してください。ただし，サスペンド状態のジョブネットに対して，ホストリンクジョブネットは削除できません。サスペンド状態のときは起動条件を削除してください。

KNAK0578-E

This method cannot be executed because JP1/AJS2 - Manager for Mainframe has not started at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先でJP1/AJS2 - Manager for Mainframeが起動していないため，メソッドは実行できません 保守情報:保守情報1, 保守情報2

接続先でJP1/AJS2 - Manager for Mainframeが起動していないため，ホストリンクジョブネットを含むユニットに対してメソッドは実行できません。

（S）

処理を中断します。

（O）

接続先でJP1/AJS2 - Manager for Mainframe のサービスを起動してください。

KNAK0579-E

An abnormality occurred in JP1/AJS2 - Manager for Mainframe or in the mainframe at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先のJP1/AJS2 - Manager for Mainframeまたはメインフレームで異常が発生しました 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS2 - Manager for Mainframe，またはメインフレームで異常が発生したため，メソッドの実行に失敗しました。

（S）

処理を中断します。

（O）

接続先JP1/AJS3 - Managerのホストにあるsyslog（UNIXの場合）や，Windowsイベントログ（Windowsの場合）などのログ情報を参照して調査してください。ログファイルの内容・情報については，マニュアル「JP1/Automatic Job Management System 2 メインフレーム 運用・操作編」のログ情報の種類について記載している個所を参照してください。

KNAK0582-E

The method that was called cannot be executed because the specified unit is in the suspended state. (maintenance information = 保守情報1, 保守情報2)

指定したユニットはサスペンド状態のため，呼び出したメソッドは実行できません 保守情報:保守情報1, 保守情報2

指定したユニットはサスペンド状態にあるため，メソッドは実行できません。

（S）

処理を中断します。

（O）

サスペンド解除をしてから，メソッドを再実行してください。

KNAK0587-E

The system could not connect to the Access Control Server at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で認証サーバに接続できません 保守情報:保守情報1, 保守情報2

接続先で認証サーバに接続できないため，処理できません。

（S）

処理を中断します。

（O）

接続先のJP1/Baseで指定している認証サーバが，起動しているかどうかを確認してください。

KNAK0588-E

You cannot make a temporary schedule change to the specified execution start day. (maintenance information = 保守情報1, 保守情報2)

指定した開始日時に計画一時変更できません 保守情報:保守情報1, 保守情報2

開始日時が2037年以降になるため，計画一時変更できません。

（S）

処理を中断します。

（O）

日時変更する場合は，変更した日時が2037年以降にならないように指定してください。

KNAK0589-E

The configuration definition at the connection destination is specified incorrectly. (構成定義パラメーター名) (maintenance information = 保守情報1, 保守情報2)

接続先の構成定義情報に誤った指定があります (構成定義パラメーター名) 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで環境設定が正しく行われていないため処理できません。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - Managerの環境設定で，メッセージに表示されている構成定義パラメーターを正しく設定してください。

KNAK0590-E

The logical host name at the connection destination is specified incorrectly. (maintenance information = 保守情報1, 保守情報2)

接続先の自論理ホスト名の設定に誤りがあります 保守情報:保守情報1, 保守情報2

接続先の環境設定で，JP1/AJS3 - SDKで接続した論理ホストに対応するホスト名が正しく設定されていないため処理できません。

（S）

処理を中断します。

（O）

接続先で，JP1/AJS3 - SDKで接続したIPアドレスに対応する論理ホスト名が正しく設定されているかどうかを確認してください。また，その論理ホスト名が接続先の環境設定で正しく論理ホストとして設定されていることを確認してください。

なお，接続先がUNIX版のJP1/AJS3 - Managerの場合，マッピングされたOSユーザーが構成定義ファイル（/opt/jp1/hcclibcnf/regdir以下のファイル）を読み込む権限があるかどうかを確認してください。

KNAK0592-E

Execute the method on a jobnet that is not scheduled to execute or is registered for a fixed execution. (maintenance information = 保守情報1, 保守情報2)

状態が未計画または確定実行登録したジョブネットに対してメソッドを実行してください 保守情報:保守情報1, 保守情報2

指定したジョブネットの状態が未計画，または確定実行登録されていないため，ルートジョブネットのスケジュールが追加できませんでした。次の原因が考えられます。

指定したジョブネットが計画実行登録されていて，次回予定がある。

指定したジョブネットが即時実行登録されていて，まだ実行されていない。

（S）

処理を中断します。

（O）

ルートジョブネットのスケジュールを追加する場合は，未計画，または確定実行登録したルートジョブネットに対してメソッドを実行してください。

KNAK0593-E

A directory required at the connection destination cannot be accessed. (maintenance information = 保守情報1, 保守情報2)

接続先で必要なディレクトリにアクセスできません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで必要なディレクトリが見つからない，またはアクセスできません。

（S）

処理を中断します。

（O）

接続先JP1/AJS3 - Managerのホストにあるsyslog（UNIXの場合）や，Windowsイベントログ（Windowsの場合）などのログ情報を参照して調査してください。ログファイルの内容・情報については，マニュアル「JP1/Automatic Job Management System 2 メインフレーム 運用・操作編」のログ情報の種類について記載している個所を参照してください。

KNAK0595-E

This method cannot be executed because the number of jobnet generations had been reached the system limit at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で世代数が上限値に達したためメソッドを実行できません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで世代数が上限値に達したため，呼び出されたメソッドを実行できません。

（S）

処理を中断します。

（O）

ジョブネットの世代数（起動条件成立によって作成される世代数を除く）が8,000世代を超えることはできません。

日付指定による確定実行登録，および計画一時変更の次回予定追加で予定を追加する場合，実行中の世代が一つ以上終了してからメソッドを再実行してください。

期間指定による確定実行登録の場合，合計が8,000世代を超えない分については登録できています。

それ以降の予定については，登録しようとする世代数分の世代が終了してから再度操作してください。

KNAK0596-E

This method cannot be executed because the system failed to delete an execution result at the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先で実行結果の削除に失敗したためメソッドを実行できません 保守情報:保守情報1, 保守情報2

接続先のJP1/AJS3 - Managerで実行結果の削除に失敗したため，呼び出されたメソッドを実行できません。

（S）

処理を中断します。

（O）

接続先のJP1/AJS3 - ManagerでメッセージKAVS0699-Eの直前にWindowsイベントログ，またはsyslogに出力されているメッセージに従って対処してください。

KNAK0600-E

When you register for execution a jobnet that is directly under a planning group, you can only perform fixed registration specified with a fixed schedule period. (maintenance information = 保守情報1, 保守情報2)

プランニンググループ直下のジョブネットを実行登録する場合，確定期間を指定した確定登録のみが可能です 保守情報:保守情報1, 保守情報2

プランニンググループの直下のジョブネットに対しては，計画登録，即時登録ができません。また，未来世代数を指定して確定登録することはできません。

（S）

処理を中断します。

（O）

プランニンググループの直下のジョブネットに対しては，確定期間を指定して確定登録してください。

KNAK0601-E

The unit to be operated is the jobnet for the connection-destination. The method that was called cannot be executed because ユニット種別 is defined. (maintenance information = 保守情報1, 保守情報2)

指定されたユニットは，接続先のジョブネットです。ユニット種別が定義されているため，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

操作対象ユニットは接続先のジョブネットです。ユニット種別が定義されているため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ユニット種別を削除してから，メソッドを再実行してください。

KNAK0602-E

The method that was called cannot be executed because the jobnet connector is in a jobnet that has a start condition. (maintenance information = 保守情報1, 保守情報2)

起動条件付きのジョブネットにジョブネットコネクタが含まれているため，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

起動条件付きのジョブネットにジョブネットコネクタが含まれているため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ジョブネットコネクタを使用する場合は，起動条件を削除してから，メソッドを再実行してください。

KNAK0603-E

The unit to be operated is a root jobnet that is directly under the planning group for the connection destination. The method that was called cannot be executed because ユニット種別 is defined. (maintenance information = 保守情報1, 保守情報2)

指定されたユニットは，接続先のプランニンググループ直下のルートジョブネットです。ユニット種別が定義されているため，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

操作対象ユニットは，接続先のプランニンググループ直下のルートジョブネットです。ユニット種別が定義されているため，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ユニット種別を削除してから，メソッドを再実行してください。

KNAK0604-E

The method that was called cannot be executed because the root remote jobnet is directly under the planning group for the connection destination. (maintenance information = 保守情報1, 保守情報2)

接続先のプランニンググループ直下のルートリモートジョブネットであるため，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

接続先のプランニンググループ直下のルートリモートジョブネットを，実行登録した状態にはできません。

（S）

処理を中断します。

（O）

ジョブグループ直下，または接続先でないプランニンググループ直下にルートリモートジョブネットを定義してから，メソッドを再実行してください。

KNAK0606-E

The method that was called cannot be executed because the schedule will be created across the release date. (maintenance information = 保守情報1, 保守情報2)

リリース日時を跨ってスケジュールを生成するため，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

リリース日時をまたいだスケジュールを生成するようメソッドを実行しました。

（S）

処理を中断します。

（O）

操作内容が正しいかどうかを確認してから，メソッドを再実行してください。

KNAK0609-E

The method that was called cannot be performed for jobnets for which release entry has been performed. (maintenance information = 保守情報1, 保守情報2)

リリース登録されているジョブネットに対して，呼び出されたメソッドは実行できません 保守情報:保守情報1, 保守情報2

リリース登録されているジョブネットに対して，呼び出されたメソッドは実行できません。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットの情報を最新にし，ユニットの情報を確認したあと，正しいユニットを指定して再度実行してください。

KNAK0611-E

The execution generation that is the target of the operation was not found. (maintenance information = 保守情報1, 保守情報2)

操作対象となる実行世代が見つかりません 保守情報:保守情報1, 保守情報2

操作対象となる世代が見つからないため，処理できません。次の原因が考えられます。

操作対象世代が保存世代数を超えた。

操作対象世代が期間限定で登録解除された。

操作対象のジョブネットが登録解除されたあと，再度実行登録された。

操作対象世代が実行中止された。

（S）

処理を中断します。

（O）

操作対象となる世代が存在するかどうかを確認してください。

KNAK0616-E

Acquisition of the generation failed. (maintenance information = 保守情報1, 保守情報2)

世代の取得に失敗しました 保守情報:保守情報1, 保守情報2

指定した世代の情報取得に失敗しました。次の原因が考えられます。

操作対象世代が保存世代数を超えた。

操作対象世代が登録解除された。

（S）

処理を中断します。

（O）

ユニット一覧取得メソッドを呼び出すなどしてユニットを最新の情報にし，ユニットの情報を確認したあと，正しいユニットを指定して再度実行してください。

KNAK0617-W

Processing of メソッド名 has been canceled. (request ID = 要求ID)

メソッド名の処理をキャンセルしました 要求ID:要求ID

メソッドの処理をキャンセルしたことを通知します。

（S）

処理を中断し，キャンセルされたことを通知します。

5.3.6　KNAK1001〜KNAK1500

APIのシンタックス不正，シーケンス不正などのメッセージの一覧を次に示します。

KNAK1001-E

The method's parameter value cannot be omitted. (method = メソッド, parameter number = 引数番号)

メソッドの引数の値は省略できません メソッド:メソッド 引数番号:引数番号

メソッドの引数の値は省略できません。

（S）

処理を中断します。

（O）

メソッドの引数番号に指定している値を修正したあと，メソッドを再実行してください。

KNAK1002-E

One or more parameter values for the method are invalid. (method = メソッド, parameter number = 引数番号)

メソッドの引数の値に誤りがあります メソッド:メソッド 引数番号:引数番号

メソッドの引数の値に誤りがあります。

（S）

処理を中断します。

（O）

メソッドの引数番号に指定している値を修正したあと，メソッドを再実行してください。

KNAK1003-E

An instance of AjsCD has already been created. (application name = アプリケーション名)

AjsCdインスタンスは既に作成済みです アプリケーション名:アプリケーション名

同じアプリケーション名のAjsCdインスタンスがすでに存在します。次の原因が考えられます。

AjsCdFactoryクラスのcreateAjsCdメソッドに指定するアプリケーション名はシステム（JDK）でユニークな値を指定してください。

AjsCdFactoryクラスのcreateAjsCdメソッドは一つのアプリケーションで一度だけ呼び出してください。

Webアプリケーションで，一つのWebコンテナ上にJP1/AJS3 - SDKを使用するWebアプリケーションを複数デプロイしている環境の場合は，ほかのWebアプリケーションが指定しているアプリケーション名と重複している可能性があります。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1004-E

An instance of AjsCD has not been created. (application name = アプリケーション名)

AjsCdインスタンスが作成されていません アプリケーション名:アプリケーション名

指定したアプリケーション名のAjsCdApiインスタンスが存在しません。次の原因が考えられます。

AjsCdFactoryクラスのcreateAjsCdメソッドを呼び出していない。

AjsCdFactoryクラスのcreateAjsCdメソッドに指定したアプリケーション名と異なるアプリケーション名で，AjsCdFactoryクラスのgetAjsCdメソッドを呼び出している。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1005-W

An instance of AjsCD has not been created. (application name = アプリケーション名)

AjsCdインスタンスが作成されていません アプリケーション名:アプリケーション名

指定したアプリケーション名のAjsCdApiインスタンスが存在しません。次の原因が考えられます。

AjsCdFactoryクラスのcreateAjsCdメソッドを呼び出していない。

AjsCdFactoryクラスのcreateAjsCdメソッドに指定したアプリケーション名と異なるアプリケーション名で，AjsCdFactoryクラスのgetAjsCdメソッドを呼び出している。

（S）

指定したアプリケーション名のAjsCdApiインスタンスが存在しないことをログに出力して，処理を続行します。

KNAK1007-E

An instance of AjsCDApi has already been created. (application name = アプリケーション名, identifier = 識別子)

AjsCdApiインスタンスは既に作成済みです アプリケーション名:アプリケーション名 識別子:識別子

同じ識別子のAjsCdApiインスタンスがすでに存在します。次の原因が考えられます。

AjsCdクラスのcreateAjsCdApiメソッドに指定する識別子はシステム（JDK）でユニークな値を指定してください。

Webアプリケーションの場合は，HTTP セッションを開始するタイミングで，AjsCdクラスのcreateAjsCdApiメソッドの識別子にHTTPセッションのセッションIDを指定して呼び出してください。

C/Sアプリケーションの場合は，クライアントアプリケーションが，サーバサイドアプリケーションの利用を開始するタイミングで，AjsCdクラスのcreateAjsCdApiメソッドを呼び出してください。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1008-E

An instance of AjsCDApi has not been created. (application name = アプリケーション名, identifier = 識別子)

AjsCdApiインスタンスが作成されていません アプリケーション名:アプリケーション名 識別子:識別子

指定した識別子のAjsCdApiインスタンスが存在しません。次の原因が考えられます。

AjsCdクラスのcreateAjsCdApiメソッドを呼び出していない。

AjsCdApiインスタンスがすでに破棄されている。AjsCdクラスのdestroyAjsCdApiメソッド，またはAjsCdFactoryクラスのdestroyAjsCdメソッドを呼び出したあとに，APIを呼び出している。

AjsCdクラスのcreateAjsCdApiメソッドに指定した識別子と異なる識別子で，AjsCdFactoryクラスのgetAjsCdApiメソッドを呼び出している。

複数のサーバが並列処理をして負荷分散することを目的としたシステム構成の場合，エンドユーザーのリクエストは必ず一つのサーバに振り分けていることを確認してください。

アプリケーションがクラスタソフトによる系切り替えをサポートしている場合，フェイルオーバーが発生している可能性があります。本製品はクラスタソフトによる系切り替えに対応してないため，インスタンスは引き継がれません。この場合，アプリケーションを利用するエンドユーザーに，いったんアプリケーションの利用終了を勧告することを推奨します。これにより，エンドユーザーがアプリケーションの利用を開始したときの処理シーケンスで，AjsCdクラスのcreateAjsCdApiメソッドが呼び出されることになります。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1009-W

An instance of AjsCDApi has not been created. (application name = アプリケーション名, identifier = 識別子)

AjsCdApiインスタンスが作成されていません アプリケーション名:アプリケーション名 識別子:識別子

指定した識別子のAjsCdApiインスタンスが存在しません。次の原因が考えられます。

AjsCdクラスのcreateAjsCdApiメソッドを呼び出していない。

AjsCdクラスのcreateAjsCdApiメソッドに指定した識別子と異なる識別子で，AjsCdクラスのdestroyAjsCdApiメソッドを呼び出している。

（S）

指定した識別子のAjsCdApiインスタンスが存在しないことをログに出力して，処理を続行します。

KNAK1010-W

You are not logged in. (connection destination host = 接続先ホスト)

ログインしていません 接続先ホスト:接続先ホスト

指定した接続先JP1/AJS3 - Managerにログインしていません。次の原因が考えられます。

loginメソッドを呼び出していない。

logoutメソッド，logoutAllメソッド，AjsCdクラスのdestroyAjsCdApiメソッド，またはAjsCdFactoryクラスのdestroyAjsCdメソッドを呼び出しており，すでにログアウト済みである。

上記以外でこのメッセージがログに出力される場合は，メソッドの第1引数の指定が誤っている可能性があります。第1引数には，loginメソッドの第1引数に指定したJP1/AJS3 - Managerのホスト名を指定してください。

（S）

処理を中断します。

（O）

ログインしていないことをログに出力して，処理を続行します。

KNAK1011-E

You are already logged in.

既にログイン済みです

指定した接続先JP1/AJS3 - Managerにはすでにログインしています。AjsCdApiインターフェースのloginメソッドを2回呼び出しています。

Webアプリケーションの場合は，HTTPセッション単位に，はじめて接続先JP1/AJS3 - ManagerにアクセスするHTTPリクエストにおいて，loginメソッドを呼び出してください。

C/Sアプリケーションの場合は，クライアントアプリケーションが，サーバサイドアプリケーションの利用を開始したあと，はじめて接続先JP1/AJS3 - Managerにアクセスするタイミングでloginメソッドを呼び出してください。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1012-E

Please log in.

ログインしてください

指定した接続先JP1/AJS3 - Managerにログインしていません。次の原因が考えられます。

Webアプリケーションの場合は，HTTPセッション単位に，はじめて接続先JP1/AJS3 - ManagerにアクセスするHTTPリクエストにおいて，loginソッドを呼び出してください。

C/Sアプリケーションの場合は，クライアントアプリケーションが，サーバサイドアプリケーションの利用を開始したあと，はじめて接続先JP1/AJS3 - Managerにアクセスするタイミングでloginメソッドを呼び出してください。

loginメソッドを呼び出しているにもかかわらずエラーになる場合は，メソッドの第1引数の指定が誤っている可能性があります。第1引数にはloginメソッドの第1引数に指定したJP1/AJS3 - Managerのホスト名を指定してください。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1013-W

Release of the login information failed. (maintenance information = 保守情報1, 保守情報2)

ログイン情報の解放に失敗しました 保守情報:保守情報1, 保守情報2

ログイン情報の解放処理に失敗したことを通知するメッセージです。

（S）

ログイン情報の解放処理に失敗したことをログに出力しました。

KNAK1014-E

Specify the 項目名.

項目名を指定してください

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」を指定していません。

（S）

処理を中断します。

（O）

項目に値を指定して，メソッドを再実行してください。

KNAK1015-E

Enter a value in the range 数値 - 数値 (bytes) for the 項目名.

項目名には数値-数値バイトの値を入力してください

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」で表示された指定が制限値内におさまっていません。

（S）

処理を中断します。

（O）

項目を「数値」に表示された長さ以内で指定してください。

KNAK1016-E

Specify a value in the range 下限値 - 上限値 for the 項目名. (指定値)

項目名には下限値-上限値の値を入力してください (指定値)

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。

（S）

処理を中断します。

（O）

「項目名」に「下限値」-「上限値」の値を指定してください。

KNAK1017-E

The 項目名 contains an invalid character. (指定値)

項目名に使用できない文字が含まれています (指定値)

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」で表示された指定に使用できない文字が含まれています。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1018-E

A specification for a regular expression in the 項目名 is incorrect. (指定値)

項目名の正規表現での指定に誤りがあります (指定値)

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」の正規表現での指定に誤りがあります。

（S）

処理を中断します。

（O）

正規表現で指定する場合，文字列の末尾を’¥’で指定しないでください。

KNAK1019-E

The 項目名 is specified incorrectly. (指定値)

項目名が正しく指定されていません (指定値)

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」に誤った形式の値を指定しています。

（S）

処理を中断します。

（O）

エラーの原因を取り除いたあと，メソッドを再実行してください。

KNAK1020-E

For the start date and time of the 項目名, specify a date and time before the end date and time. (start date and time = 指定値, end date and time = 指定値)

項目名の開始には終了以前の日時を指定してください 開始:指定値 終了:指定値

AjsCdApiクラスのメソッドの引数に指定した値に誤りがあります。「項目名」の開始日時に，終了日時よりあとの日時を指定しています。

（S）

処理を中断します。

（O）

「項目名」の開始日時を終了日時以前の日時に変更してください。

KNAK1021-E

指定値 cannot be specified for the character code.

文字コードに指定値は指定できません

サポートしていない文字コードを指定しています。

（S）

処理を中断します。

（O）

文字コードの指定が正しいかどうかを確認してください。

KNAK1022-E

The value specified in the メソッド名 method is invalid.

メソッド名メソッドで指定した値に誤りがあります

「メソッド名」メソッドで指定した値に誤りがあります。

（S）

処理を中断します。

（O）

「メソッド名」で指定した値が正しいかどうかを確認してください。

KNAK1024-E

The 項目名 cannot be omitted if the comparison method is 比較方法.

比較方法が比較方法の場合，項目名は省略できません

「項目名」または比較方法の指定に誤りがあります。

（S）

処理を中断します。

（O）

「項目名」に値を指定するか，「比較方法」を変更してください。

KNAK1025-E

For the 項目名, specify a value of at least 1 minute.

項目名には1分以上の値を指定してください

「項目名」に指定した値に誤りがあります。0分となる値は指定できません。

（S）

処理を中断します。

（O）

「項目名」には0分以外の値を指定してください。

KNAK1026-E

The specification count for the 項目名 exceeds 数値.

項目名の指定が数値個を超えています

「項目名」の指定が制限値を超えています。

（S）

処理を中断します。

（O）

項目を「数値」に表示された個数以内で指定してください。

KNAK1027-E

The specification value for the 項目名 exceeds 数値 bytes.

項目名の指定が数値バイトを超えています

「項目名」の指定が制限値を超えています。

（S）

処理を中断します。

（O）

項目を「数値」に表示された長さ以内で指定してください。

KNAK1028-E

Specify both start and end days in the fixed schedule period.

確定期間には開始年月日と終了年月日の両方を指定してください

確定期間の開始年月日と終了年月日の両方が指定されていないため，確定実行登録できません。

（S）

処理を中断します。

（O）

確定期間を指定して確定実行登録する場合は，開始年月日と終了年月日の両方を指定してください。

KNAK1029-E

For the start date of the fixed schedule period, specify a date before the end date. (start date = 開始年月日, end date = 終了年月日)

確定期間の開始年月日には終了年月日以前の日付を指定してください 開始年月日:開始年月日 終了年月日:終了年月日

確定期間の開始年月日に，終了年月日よりあとの日付が指定されているため，確定実行登録できません。

（S）

処理を中断します。

（O）

確定期間を指定して確定実行登録する場合は，開始年月日には終了年月日以前の日付を指定してください。

KNAK1030-E

Specify the fixed schedule period or the number of future generations.

確定期間または未来世代数を指定してください

確定期間，または未来世代数が指定されていないため，確定実行登録できません。

（S）

処理を中断します。

（O）

確定実行登録する場合は，確定期間，または未来世代数を指定してください。

KNAK1031-E

指定値 and 指定値 cannot be specified at the same time.

指定値と指定値は同時に指定できません

同時に指定できない引数を指定しています。

（S）

処理を中断します。

（O）

指定した引数を確認し，同時に指定できる引数の組み合わせで，メソッドを再実行してください。

KNAK1032-E

The unit hierarchy exceeds the maximum value (階層最大値). (ユニット完全名)

ユニットの階層最大値(階層最大値)を超えています (ユニット完全名)

ユニットの階層最大値を超えるユニット完全名を指定しています。

（S）

処理を中断します。

（O）

ユニットの階層は最大値以内で指定してください。

KNAK1033-E

The user name or password is invalid.

ユーザー名かパスワードに誤りがあります

JP1ユーザー名またはパスワードに誤りがあったため，ログインできませんでした。

（S）

処理を中断します。

（O）

接続先の認証サーバで登録されている，JP1ユーザー名とパスワードを入力して，ログインしてください。

KNAK1100-E

Methods called by a job group cannot be executed. (ユニット完全名)

ジョブグループに呼び出されたメソッドは実行できません (ユニット完全名)

ジョブグループを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

ジョブグループ以外のユニットを指定して，メソッドを再実行してください。

KNAK1101-E

Methods called by a remote jobnet cannot be executed. (ユニット完全名)

リモートジョブネットに呼び出されたメソッドは実行できません (ユニット完全名)

リモートジョブネットを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

リモートジョブネット以外のユニットを指定して，メソッドを再実行してください。

KNAK1102-E

Specify a job or root jobnet. (ユニット完全名)

ジョブまたはルートジョブネットを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ジョブまたはルートジョブネットを指定して，メソッドを再実行してください。

KNAK1103-E

Methods called by a unit in a remote jobnet cannot be executed. (ユニット完全名)

リモートジョブネット配下のユニットに呼び出されたメソッドは実行できません (ユニット完全名)

リモートジョブネット配下のユニットを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

リモートジョブネット配下以外のユニットを指定して，メソッドを再実行してください。

KNAK1104-E

Execution result details about the specified jobnet cannot be obtained. (ユニット完全名)

指定したジョブネットに対して実行結果詳細は取得できません (ユニット完全名)

以下のどの条件も満たさないジョブネットを指定して，メソッドが実行されました。

リモートジョブネット

ジョブネットコネクタ

ジョブネットコネクタの接続先

親ユニットがジョブコネットネクタの接続先であるルートジョブネット

待ち合わせ条件が設定されている

（S）

処理を中断します。

（O）

以下のどれかの条件を満たすジョブネットを指定して，メソッドを再実行してください。

リモートジョブネット

ジョブネットコネクタ

ジョブネットコネクタの接続先

親ユニットがジョブコネットネクタの接続先であるルートジョブネット

待ち合わせ条件が設定されている

KNAK1105-E

Specify the root jobnet. (ユニット完全名)

ルートジョブネットを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ルートジョブネットを指定して，メソッドを再実行してください。

KNAK1106-E

Methods called by a manager jobnet cannot be executed. (ユニット完全名)

マネージャージョブネットに呼び出されたメソッドは実行できません (ユニット完全名)

マネージャージョブネットを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

マネージャージョブネットの参照先ジョブネットに対して，メソッドを再実行してください。

KNAK1107-E

Methods called by a jobnet that is directly under the planning group cannot be executed. (ユニット完全名)

プランニンググループ直下のジョブネットに呼び出されたメソッドは実行できません (ユニット完全名)

プランニンググループの直下のジョブネットに対しては，計画実行登録，即時実行登録，実行予定追加ができません。

（S）

処理を中断します。

（O）

プランニンググループの直下のジョブネットに対しては，確定期間を指定して確定実行登録してください。

KNAK1108-E

Methods called by a hostlink jobnet cannot be executed. (ユニット完全名)

ホストリンクジョブネットに呼び出されたメソッドは実行できません (ユニット完全名)

ホストリンクジョブネットを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

ホストリンクジョブネット以外のユニットを指定して，メソッドを再実行してください。

KNAK1109-E

Methods called by a jobnet connector cannot be executed. (ユニット完全名)

ジョブネットコネクタに呼び出されたメソッドは実行できません (ユニット完全名)

ジョブネットコネクタを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

ジョブネットコネクタ以外のユニットを指定して，メソッドを再実行してください。

KNAK1110-E

Specify a jobnet. (ユニット完全名)

ジョブネットを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ジョブネットを指定して，メソッドを再実行してください。

KNAK1111-E

Method parameters cannot be omitted when a root jobnet is specified. (method = メソッド, parameter number = 引数番号)

ルートジョブネットを指定して，メソッドの引数を省略することはできません メソッド:メソッド 引数番号:引数番号

指定したユニットがルートジョブネットの場合，メソッドの引数を省略することはできません。

（S）

処理を中断します。

（O）

メソッドの引数番号に指定している値を修正したあと，メソッドを再実行してください。

KNAK1112-E

The specified delay monitoring method (指定値) cannot be specified for the root jobnet.

指定した遅延監視方法(指定値)は，ルートジョブネットに指定できません

指定した遅延監視方法に誤りがあります。

（S）

処理を中断します。

（O）

指定した引数を確認し，ルートジョブネットに指定できる引数を指定して，メソッドを再実行してください。

KNAK1113-E

Specify a job. (ユニット完全名)

ジョブを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ジョブを指定して，メソッドを再実行してください。

KNAK1114-E

When you register for execution a jobnet that is directly under a planning group, you can only perform fixed registration specified with a fixed schedule period. (ユニット完全名)

プランニンググループ直下のジョブネットを実行登録する場合，確定期間を指定した確定実行登録のみが可能です (ユニット完全名)

プランニンググループの直下のジョブネットに対しては，未来世代数を指定して確定実行登録することはできません。

（S）

処理を中断します。

（O）

プランニンググループの直下のジョブネットに対しては，確定期間を指定して確定実行登録してください。

KNAK1115-E

Immediate registrations with start conditions specified cannot be performed for an Operation Net scheduler service unit.

オペレーションネット用スケジューラーサービス配下のユニットに対して，起動条件を指定した即時実行登録はできません

オペレーションネット用スケジューラーサービス配下のユニットに対しては，起動条件を使用することはできません。

（S）

処理を中断します。

（O）

オペレーションネット用スケジューラーサービス配下のユニットに対しては，起動条件を使用せずに実行登録してください。

KNAK1116-E

The specified rerun method (指定値) cannot be specified for the root jobnet.

指定した再実行方法(指定値)は，ルートジョブネットでは指定できません

指定した再実行方法に誤りがあります。

（S）

処理を中断します。

（O）

指定した引数を確認し，ルートジョブネットに指定できる引数を指定して，メソッドを再実行してください。

KNAK1117-E

The specified rerun method (指定値) cannot be specified for a nest jobnet or a job.

指定した再実行方法(指定値)は，ネストジョブネットまたはジョブでは指定できません

指定した再実行方法に誤りがあります。

（S）

処理を中断します。

（O）

指定した引数を確認し，ネストジョブネットまたはジョブに指定できる引数を指定して，メソッドを再実行してください。

KNAK1118-E

A jobnet connector or a hostlink jobnet cannot be rerun if it is in hold status.

ジョブネットコネクタまたはホストリンクジョブネットを保留状態にして再実行することはできません

ジョブネットコネクタまたはホストリンクジョブネットに対して，保留状態にして再実行することはできません。

（S）

処理を中断します。

（O）

保留状態にしない指定で，メソッドを再実行してください。

KNAK1119-E

The status of the specified unit (ユニット完全名) cannot be changed to (指定値).

指定したユニット(ユニット完全名)は，指定した状態(指定値)に変更することはできません

指定した変更後の状態に誤りがあります。

（S）

処理を中断します。

（O）

指定した引数を確認し，ユニットで変更できる状態を指定して，メソッドを再実行してください。

KNAK1120-E

The result code for the specified unit (ユニット完全名) cannot be changed.

指定したユニット(ユニット完全名)は，終了コードを変更することはできません

終了コードが変更できないユニットに対して，メソッドが実行されました。

（S）

処理を中断します。

（O）

指定した引数を確認し，ユニットに指定できる引数を指定して，メソッドを再実行してください。

KNAK1122-E

A method that was called by a job or a hostlink jobnet that is directly under a job group cannot be executed. (ユニット完全名)

ジョブグループ直下のジョブおよびホストリンクジョブネットに呼び出されたメソッドは実行できません (ユニット完全名)

ジョブグループ直下のジョブ，またはホストリンクジョブネットを指定して，メソッドが実行されました。

（S）

処理を中断します。

（O）

ジョブグループ直下のジョブおよびホストリンクジョブネット以外のユニットを指定して，メソッドを再実行してください。

KNAK1123-E

Only methods called by a jobnet or a start condition can be executed. (ユニット完全名)

ジョブネットおよび起動条件以外に呼び出されたメソッドは実行できません (ユニット完全名)

引数に指定できないユニット種別を指定して，メソッドが実行されました。次の原因が考えられます。

ジョブネットまたは起動条件以外のユニットが指定された。

リモートジョブネット配下のネストジョブネットが指定された。

（S）

処理を中断します。

（O）

ジョブネットまたは起動条件のユニットを指定して，メソッドを再実行してください。

KNAK1124-E

A schedule cannot be added to the specified jobnet. (ユニット完全名)

指定したジョブネットには予定を追加できません (ユニット完全名)

指定したジョブネットの世代には，すでに予定が存在します。

（S）

処理を中断します。

（O）

指定したユニットおよび実行IDが正しいかどうかを確認してください。

KNAK1125-E

Specify a nest jobnet. (ユニット完全名)

ネストジョブネットを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ネストジョブネットを指定してメソッドを再実行してください。

KNAK1126-E

The macro variable cannot be specified for the root remote jobnet. (ユニット完全名)

ルートリモートジョブネットに対してマクロ変数は指定できません (ユニット完全名)

ルートリモートジョブネットに対して，マクロ変数を指定してメソッドが実行されました。

（S）

処理を中断します。

（O）

マクロ変数を指定せずに，メソッドを再実行してください。

KNAK1127-E

Specify a job group or planning group. (ユニット完全名)

ジョブグループまたはプランニンググループを指定してください (ユニット完全名)

メソッドの操作対象でないユニットが指定されました。

（S）

処理を中断します。

（O）

ジョブグループまたはプランニンググループを指定してメソッドを再実行してください。

KNAK1128-E

For the start date, specify a date before the end date. (start date = 指定値, end date = 指定値)

開始日には終了日以前の日付を指定してください 開始日:指定値 終了日:指定値

開始日に，終了日よりあとの日付が指定されています。

（S）

処理を中断します。

（O）

開始日には終了日以前の日付を指定してください。

KNAK1129-E

The unit type is invalid. (ユニット完全名)

ユニットの種別が不正です (ユニット完全名)

メソッドの操作対象でない種別のユニットが指定されました。

（S）

処理を中断します。

（O）

メソッドごとに指定できるユニットの種別が異なります。次に示すメソッドに対応する種別のユニットを指定して，メソッドを再実行してください。

getCalendarメソッドに対応するユニット

ジョブグループ

プランニンググループ

ルートジョブネット

ルートリモートジョブネット

getJobnetSummaryメソッドに対応するユニット

ルートジョブネット

ルートリモートジョブネット

プランニンググループ

KNAK1130-E

The specified release ID does not exist. (リリースID)

指定したリリースIDは存在しません (リリースID)

ジョブネットに指定したリリースIDは存在しません。

（S）

処理を中断します。

（O）

ジョブネットにリリース登録されているジョブネットIDを指定して，メソッドを再実行してください。

KNAK1131-E

The release ID cannot be specified for the unit. (ユニット完全名)

指定したユニットにリリースIDは指定できません (ユニット完全名)

リリース登録できない種別のユニットにリリースIDが指定されました。

（S）

処理を中断します。

（O）

指定したユニットが正しいかどうかを確認して，再実行してください。

KNAK1132-E

The execution ID cannot be specified for the unit. (ユニット完全名)

指定したユニットに実行IDは指定できません (ユニット完全名)

実行登録できない種別のユニットに実行IDが指定されました。

（S）

処理を中断します。

（O）

指定したユニットが正しいかどうかを確認して，再実行してください。

KNAK1133-E

For the start time, specify a time before the end time. (start time = 指定値, end time =指定値)

開始には終了以前の日付を指定してください 開始:指定値 終了:指定値

開始時間に，終了時間よりあとの時間が指定されています。

（S）

処理を中断します。

（O）

開始時間には終了時間以前の時間を，「1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）」で指定してください。

5.3.7　KNAK1501〜KNAK1600

致命的なエラーのメッセージの一覧を次に示します。

KNAK1501-E

An unexpected error occurred during processing (処理名). (detailed information = 詳細情報1, 詳細情報2, 詳細情報3)

(処理名)処理中に予期しないエラーが発生しました 詳細情報:詳細情報1, 詳細情報2, 詳細情報3

「処理名」の処理中に予期しないエラーが発生しました。次の原因が考えられます。

destroyAjsCdApiメソッドまたはdestroyAjsCdメソッドを実行して，処理中のAPIが強制的に破棄された

（S）

「処理名」の処理を中断します。

（O）

「強制破棄」を指定して，destroyAjsCdApiメソッドまたはdestroyAjsCdメソッドを実行した場合は，APIの処理がどこまで反映されているかを確認してください。

それ以外の場合は，エラーの原因を取り除いてください。解決できない場合は，資料を採取したあと，システム管理者に連絡してください。

KNAK1503-E

A required class file (クラスファイル名) was not found. (maintenance information = 保守情報1, 保守情報2, 保守情報3)

必要なクラスファイル(クラスファイル名)が見つかりません 保守情報:保守情報1, 保守情報2, 保守情報3

JP1/AJS3 - SDKの実行に必要なクラスファイルが見つかりません。

（S）

処理を中断します。

（O）

JP1/AJS3 - SDKの構成が壊れていることが考えられます。解決できない場合は，資料を採取したあと，システム管理者に連絡してください。

5.3.8　KNAK1601〜KNAK1700

インストーラー関連のメッセージの一覧を次に示します。

KNAK1601-E

This platform is not supported. Installation stops.

このプラットフォームは適用OSではありません。インストールを中断します。

適用OSの条件を満たさないプラットフォームにJP1/AJS3製品をインストールしようとしたため，インストールを中断しました。

現在インストールしようとしているJP1/AJS3製品は，このプラットフォームにインストールできません。

（S）

インストールを中断します。

（O）

JP1/AJS3製品の適用OSを確認した上，該当するOSにインストールしてください。適用OSの詳細については，リリースノートを参照してください。

KNAK1602-E

The user who executed the installation is not an administrator. An administrator is required to install Automatic Job Management System 3 - Software Development Kit.

インストールを実行したユーザーには管理者権限がありません。本製品のインストールには，管理者権限が必要です。

インストールを実行したユーザーは管理者権限を持っていないため，インストールできません。

（S）

インストールを中断します。

（O）

管理者権限を持つユーザーがJP1/AJS3製品をインストールしてください。

KNAK1603-E

The Hitachi Integrated Installer disc might be corrupted. Installation cannot continue.

インストール媒体不良の可能性があります。インストールを続行できません。

インストール中にエラーが発生したため，インストールを中断しました。次に示す要因が考えられます。

日立総合インストーラーの媒体に不良がある。

日立総合インストーラーをローカルディスクにコピーしている場合，コピーに失敗している。

（S）

インストールを中断します。

（O）

ほかの日立総合インストーラーの媒体がある場合は，そちらの媒体を使用して再度インストールしてください。

日立総合インストーラーをローカルディスクにコピーしている場合は，再度コピーしたあとインストールしてください。または，日立総合インストーラーの媒体を使用してインストールしてください。

解決しない場合は，次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

インストールログ（システムフォルダ¥Temp¥HCDINSTフォルダ）

上書きインストールまたはバージョンアップインストールの場合は，次の資料も採取してください。

資料採取ツールの実行結果

KNAK1604-E

Setting of license management information failed. The installation will stop. (保守情報)

ライセンス管理情報の設定に失敗しました。インストールを中断します。(保守情報)

ライセンス管理情報の設定に失敗したため，インストールを中断しました。

（S）

インストールを中断します。

（O）

次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

インストールログ（システムフォルダ¥Temp¥HCDINSTフォルダ）

上書きインストールまたはバージョンアップインストールの場合は，次の資料も採取してください。

資料採取ツールの実行結果

KNAK1605-E

The installation will stop because the trial version of Automatic Job Management System 3 - Software Development Kit is already installed.

体験版がインストールされているため，インストールを中断します。

体験版がインストールされているホストに製品版を上書きインストール，またはバージョンアップインストールしようとしたため，インストールを中断しました。

（S）

インストールを中断します。

（O）

体験版をアンインストールしたあと，再度製品版をインストールしてください。

KNAK1631-W

Setting of the integrated trace log failed.

統合トレースログの設定に失敗しました。

インストール時に，統合トレースログの設定に失敗しました。次に示す要因が考えられます。

レジストリ「HKEY_LOCAL_MACHINE¥SOFTWARE」のアクセス許可として，フルコントロールを与えているのがEveryoneだけである。

（S）

インストールを続行します。

（O）

レジストリ「HKEY_LOCAL_MACHINE¥SOFTWARE」のアクセス許可にAdministratorsグループを追加して，フルコントロールを付与したあと，再度インストールしてください。

解決しない場合は，次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

レジストリ「HKEY_LOCAL_MACHINE¥SOFTWARE」のアクセス許可のハードコピー

レジストリ「HKEY_LOCAL_MACHINE¥SOFTWARE¥HITACHI¥HNTRLIB2¥HNTR1」のアクセス許可のハードコピー

資料採取ツールの実行結果

KNAK1632-W

Unsetting of the integrated trace log failed.

統合トレースログの設定解除に失敗しました。

アンインストール時に，統合トレースログの設定解除に失敗しました。

（S）

アンインストールを続行します。

（O）

次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

インストールログ（システムフォルダ¥Temp¥HCDINSTフォルダ）

KNAK1633-W

Deletion of the integrated trace log failed.

統合トレースログの削除に失敗しました。

アンインストール時に，統合トレースログの削除に失敗しました。

（S）

アンインストールを続行します。

（O）

次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

インストールログ（システムフォルダ¥Temp¥HCDINSTフォルダ）

KNAK1671-Q

The Hitachi Integrated Installer disc could not be found. Insert the disc into the drive.

日立総合インストーラーの媒体が見つかりません。媒体を挿入してください。

日立総合インストーラーの媒体上のファイルが見つからなかったため，確認します。

（S）

応答を待ちます。

（O）

インストールを続行する場合は，日立総合インストーラーの媒体を挿入したあと，［はい］ボタンをクリックしてください。インストールを続行しない場合は，［いいえ］ボタンをクリックし，インストールを終了してください。

日立総合インストーラーの媒体を挿入しても解決しない場合は，次の資料を採取したあと，システム管理者に連絡してください。

行った操作の詳細

画面に表示されたダイアログボックスのハードコピー

インストールログ（システムフォルダ¥Temp¥HCDINSTフォルダ）

上書きインストールまたはバージョンアップインストールの場合は，次の資料も採取してください。

資料採取ツールの実行結果

付録

付録A　定数

データ型クラスおよび例外クラスのメソッドでは，列挙型の定数を使用します。

パッケージ名

データ型クラスの場合：jp.co.Hitachi.soft.jp1.ajs.cd.api.data

例外クラスの場合：jp.co.Hitachi.soft.jp1.ajs.cd.common

データ型クラスで使用する列挙型定数の一覧を表A-1，例外クラスで使用する列挙型定数の一覧を表A-2に示します。

表A‒1　データ型クラスの列挙型定数の一覧

項番

場所

列挙型

説明

1

AjsCdOperation

PlannedTimePassedType

デーモン起動時および実行登録時の予定時刻超過時の動作

2

ChangeStartTimeType

計画一時変更時の実行開始日時の種類

3

ChangePushedAheadType

計画一時変更時の前倒しの動作

4

ChangeLowerType

計画一時変更時の配下の開始日時の動作

5

ChangeHoldAttr

保留時の属性

6

DelayMonitorType

遅延監視する方法

7

RootRerunType

ルートジョブネットを再実行する方法

8

RerunType

ネストジョブネットまたはジョブを再実行する方法

9

RerunOption

再実行オプション

10

ChangeStatus

状態変更の変更後の状態

11

DestroyOption

破棄のオプション指定

12

AjsCdUnitInfo

Type

ユニットの種別

13

RegisterStatus

ユニットの登録状態

14

AjsCdUnitStatus

Status

ユニットの状態

15

DelayStart

開始遅延の有無

16

DelayEnd

終了遅延の有無

17

ChangeType

計画一時変更の有無

18

HoldAttr

実行予定の保留属性

19

HoldPlan

保留予定の有無

20

ExecutionType

登録種別

21

TimeType

起動条件の有効範囲の時間の種別

22

RetryStatus

リトライ状態

23

StatusInSummary

サマリーでカウントする状態

24

AjsCdUnitRelation

RelationType

関連線の種別

25

AjsCdStartCondition

TimeType

起動条件の有効範囲の時間の種別

26

AjsCdSearchCondition

LowerType

ユニット取得条件の配下の取得方法

27

UnitType

ユニット取得条件のユニット種別

28

GenerationType

ユニット取得条件の世代の取得方法

29

UnitStatus

ユニット取得条件のユニット状態

30

DelayType

ユニット取得条件の遅延の指定

31

HoldAttr

ユニット取得条件の保留状態

32

MatchMethods

文字列の比較方法

33

SearchTargetType

ユニット取得条件の取得対象の範囲

35

ReleaseInfoSearchMethods

ユニット取得条件のリリース情報の取得方法

36

AjsCdSchServiceInfo

DBType

スケジューラーサービスのデータベース種別

37

AjsCdAJSManagerInfo

OSType

OS種別

38

OSDetail

OS詳細

39

OSArchitecture

OSアーキテクチャ

40

LinuxVersion

Linuxのバージョン

41

DBConfigType

データベース構成

42

AjsCdGetOption

GetHoldPlanType

保留予定の有無の取得要否

43

DateType

取得開始終了日時の指定種別

44

AjsCdCalendar

BaseType

基準日の指定値

45

MonthType

月区分

46

WeekDay

基準日の曜日

47

DayType

運用日，休業日の情報

48

AjsCdGetSummaryOption

SummaryType

サマリー情報取得時の取得情報の種類

49

AjsCdJobnetReleaseInfo

ReleaseStatus

リリース状態

表A‒2　例外クラスの列挙型定数の一覧

項番

場所

列挙型

説明

1

AjsCdReturnCode

ReturnCode

リターンコード情報の終了コード

2

DetailCode

リターンコード情報の詳細コード

付録A.1　AjsCdOperationの定数

AjsCdOperationの定数について説明します。

(1)　PlannedTimePassedType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

デーモン起動時および実行登録時の予定時刻超過時の動作の種類を示します。

定数一覧

項番

定数名

説明

1

IMMEDIATE

すぐに実行する

2

NEXTTIME

次回から実行する

(2)　ChangeStartTimeType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

計画一時変更時の実行開始日時の種類を示します。

定数一覧

項番

定数名

説明

1

ABSOLUTETIME

開始日時を指定する

2

RELATIVETIME

相対日時を指定する

(3)　ChangePushedAheadType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

計画一時変更時の前倒しの動作の種類を示します。

定数一覧

項番

定数名

説明

1

ADD

次回予定追加

2

MOVE

次回予定移動

(4)　ChangeLowerType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

計画一時変更時の配下の開始日時の動作の種類を示します。

定数一覧

項番

定数名

説明

1

NOTSHIFT

配下の開始日時はずらさない

2

SHIFT

配下の開始日時もずらす

(5)　ChangeHoldAttr

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

保留時の属性を示します。

定数一覧

項番

定数名

説明

1

SET

保留属性設定

2

RELEASE

保留属性解除

(6)　DelayMonitorType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

遅延監視する方法を示します。

定数一覧

項番

定数名

説明

1

NOT

監視しない

2

ABSOLUTE

絶対時刻

3

ROOT※

ルートジョブネットの開始予定時刻からの相対

4

TOP※

上位ジョブネットの開始予定時刻空の相対

5

OWN

自ジョブネットの開始予定時刻からの相対

注※　この項目はルートジョブネットの場合，指定できません。

(7)　RootRerunType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

ルートジョブネットを再実行する方法を示します。

定数一覧

項番

定数名

説明

1

TOP

指定したルートジョブネットの先頭のジョブから再実行します。

2

ABNORMAL_JOB

指定したルートジョブネットのジョブの中で，異常終了したジョブから再実行します。

3

ABNORMAL_NEXT

指定したルートジョブネットのジョブの中で，異常終了したジョブの次のジョブから再実行します。

4

ABNORMAL_JOBNET

指定したルートジョブネット中のネストジョブネットの中で，異常終了したジョブネットから再実行します

5

WARNING

指定したルートジョブネットのジョブの中で，警告終了したジョブだけ再実行します。

(8)　RerunType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

ネストジョブネットまたはジョブを再実行する方法を示します。

定数一覧

項番

定数名

説明

1

FROM

指定したユニットとそれ以降のユニットを再実行します。

2

ONLY

指定したユニットだけを再実行します。

3

NEXT

指定したユニットの次のユニットから再実行します。

(9)　RerunOption

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

再実行オプションを示します。

定数一覧

項番

定数名

説明

1

HOLD

保留状態にします。

なお，ネストジョブネットまたはジョブの場合，再実行方法（RerunType）で「FROM」または「ONLY」を指定した場合に有効です。

「NEXT」を指定した場合，ジョブネットコネクタの場合，およびホストリンクジョブネットの場合，この項目は指定できません。

無効な条件で指定された場合，例外を送出します。

2

WARNING

異常状態の先行ユニットがある場合に，そのユニットの終了状態を警告終了にします。

なお，ルートジョブネットの場合，再実行方法（RootRerunType）に「ABNORMAL_NEXT」を指定した場合に指定できます。無効な条件で指定された場合，例外を送出します。

(10)　ChangeStatus

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

状態変更の変更後の状態を示します。

定数一覧

項番

定数名

説明

1

NOT

ジョブの状態を変更しません。

2

NORMAL

ジョブの状態を正常終了にします。

3

FAIL

ジョブの状態を起動失敗にします。

4

WARNING

ジョブの状態を警告検出終了にします。

5

ABNORMAL

ジョブの状態を異常検出終了にします。

6

BYPASS

ジョブの状態を計画未実行にします。

7

RETURNCODE

ジョブの状態を終了コードで判定し，指定した終了コードに変更します。

ユニットがイベントジョブ，アクションジョブ，またはORジョブの場合は指定できません。

(11)　DestroyOption

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdOperation

説明

破棄のオプションを示します。

定数一覧

項番

定数名

説明

1

FORCE

強制破棄

付録A.2　AjsCdUnitInfoの定数

AjsCdUnitInfoの定数について説明します。

(1)　Type

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitInfo

説明

ユニットの種別を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

GROUP

ジョブグループ

4

MANGROUP

マネージャージョブグループ

5

PLNGROUP

プランニンググループ

6

ROOTNET

ルートジョブネット

7

NET

ネストジョブネット

8

ROOTRNET

ルートリモートジョブネット

9

RMNET

ネストリモートジョブネット

10

HLNET

ホストリンクジョブネット

11

MANNET

マネージャージョブネット

12

JOB

UNIXジョブ

13

PJOB

PCジョブ

14

QJOB

QUEUEジョブ

15

NETCN

ジョブネットコネクタ

16

JDJOB

判定ジョブ

17

ORJOB

ORジョブ

18

CMSJB

JP1/Cm2状態通知ジョブ

19

EVWJB

JP1イベント受信監視ジョブ

20

FLWJB

ファイル監視ジョブ

21

MLWJB

メール受信監視ジョブ

22

MQWJB

メッセージキュー受信監視ジョブ

23

MSWJB

MSMQ受信監視ジョブ

24

LFWJB

ログファイル監視ジョブ

25

NTWJB

Windowsイベント監視ジョブ

26

TMWJB

実行間隔制御ジョブ

27

EVSJB

JP1イベント送信ジョブ

28

MLSJB

メール送信ジョブ

29

MQSJB

メッセージキュー送信ジョブ

30

MSSJB

MSMQ送信ジョブ

31

PWLJB

ローカル電源制御ジョブ

32

PWRJB

リモート電源制御ジョブ

33

COND

起動条件

34

AJSVAR

引き継ぎ情報設定ジョブ

35

OPNET

オペレーションジョブ

36

CUSTOM

カスタムジョブ

(2)　RegisterStatus

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitInfo

説明

ユニットの登録状態を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

YES

登録済み

4

NO

未登録

付録A.3　AjsCdUnitStatusの定数

AjsCdUnitStatusの定数について説明します。

(1)　Status

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

ユニットの状態を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

NOPLAN

未計画

4

UNEXEC

未実行終了

5

BYPASS

計画未実行

6

EXECDEFFER

繰越未実行

7

SHUTDOWN

閉塞

8

TIMEWAIT

開始時刻待ち

9

TERMWAIT

先行終了待ち

10

EXECWAIT

実行待ち

11

QUEUING

キューイング

12

CONDITIONWAIT

起動条件待ち

13

HOLDING

保留中

14

RUNNING

実行中

15

WACONT

警告検出実行中

16

ABCONT

異常検出実行中

17

MONITORING

監視中

18

ABNORMAL

異常検出終了

19

INVALIDSEQ

順序不正

20

INTERRUPT

中断

21

KILL

強制終了

22

FAIL

起動失敗

23

UNKNOWN

終了状態不明

24

MONITORCLOSE

監視打ち切り終了

25

WARNING

警告検出終了

26

NORMAL

正常終了

27

NORMALFALSE

正常終了−偽

28

UNEXECMONITOR

監視未起動終了

29

MONITORINTRPT

監視中断

30

MONITORNORMAL

監視正常終了

(2)　DelayStart

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

開始遅延の有無を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

YES

開始遅延あり

4

NO

開始遅延なし

(3)　DelayEnd

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

終了遅延の有無を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

YES

終了遅延あり

4

NO

終了遅延なし

(4)　ChangeType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

計画一時変更の有無を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

NO

なし

4

TIME

日時変更あり

5

CANCEL

実行中止あり

6

MOVEMENT

連動一時変更あり

(5)　HoldAttr

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

保留属性を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

NO

定義に従う（保留しない）

4

YES

定義に従う（保留する）

5

YES_ERR

定義に従う（前回異常時だけ保留する）

6

YES_WAR

定義に従う（前回異常警告時だけ保留する）

7

HOLD

一時変更保留決定

8

RELEASE

一時変更保留解除

(6)　HoldPlan

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

保留予定の有無を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

PLAN_NO

保留予定なし

4

PLAN_YES

保留予定あり

(7)　ExecutionType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

登録種別を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

PLANNED

計画実行

4

IMMEDIATE

即時実行

5

FIXED

確定実行

6

SIMULATION

擬似予定

(8)　TimeType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

起動条件の有効範囲の時間の種別を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

NO

指定なし

4

ABSOLUTE

絶対時間

5

RELATIVE

相対時間

6

UNLIMITED

無制限

(9)　RetryStatus

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

リトライ状態を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

RETRY_NO

リトライ設定なし※

4

RETRY_WAIT

リトライ待ち

5

RETRY_RUNNING

リトライ実行中

6

RETRY_END

リトライ終了

注※

UNIXジョブ，PCジョブ，QUEUEジョブ，標準カスタムジョブ，カスタムPCジョブ，カスタムUNIXジョブ，またはオペーレーションジョブ以外のユニットの場合も「リトライ設定なし」となります。

(10)　StatusInSummary

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitStatus

説明

サマリーでカウントする状態を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

WAIT

開始待ち

4

HOLD

保留中

5

RUN

実行中

6

ABNORMAL

異常終了

7

WARNING

警告終了

8

NORMAL

正常終了

9

DELAY

遅延※

注※

遅延は，ほかの状態と区別してカウントされます。

例えば，ユニットの状態が実行中で開始遅延ありの場合は，遅延と実行中の両方にカウントされます。

付録A.4　AjsCdUnitRelationの定数

AjsCdUnitRelationの定数について説明します。

(1)　RelationType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdUnitRelation

説明

関連線の種別を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

NORMAL

通常の関連線接続

4

JUDGE

条件接続

付録A.5　AjsCdStartConditionの定数

AjsCdStartConditionの定数について説明します。

(1)　TimeType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdStartCondition

説明

起動条件の有効範囲の時間の種別を示します。

定数一覧

項番

定数名

説明

1

ABSOLUTE

絶対時間

2

RELATIVE

相対時間

3

NO

指定なし（無制限）

付録A.6　AjsCdSearchConditionの定数

AjsCdSearchConditionの定数について説明します。

(1)　LowerType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの配下の取得方法を示します。

定数一覧

項番

定数名

説明

1

YES

setSearchLocationで指定したユニットの配下をすべて取得対象とする

2

NO

setSearchLocationで指定したユニットの直下１階層にあるユニットだけを取得対象とする

(2)　UnitType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionのユニット種別を示します。

定数一覧

項番

定数名

説明

1

NO

検索条件にしない

2

GROUP

ジョブグループだけの情報を取得します。

対象は以下のユニット種別です。

ジョブグループ

プランニンググループ

マネージャージョブグループ

3

ROOT

ルートジョブネットだけの情報を取得します。

対象は以下のユニット種別です。

ルートジョブネット

ルートリモートジョブネット

ルートマネージャージョブネット

4

NET

ジョブネットだけの情報を取得します。

対象は以下のユニット種別です。

ルートジョブネット

ルートリモートジョブネット

マネージャージョブネット

ネストジョブネット

ネストリモートジョブネット

ホストリンクジョブネット

5

JOB

ジョブだけの情報を取得します。

対象は標準ジョブ，イベントジョブ，アクションジョブ，カスタムジョブのすべてです。

(3)　GenerationType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの世代の取得方法を示します。

定数一覧

項番

定数名

説明

1

NO

世代を検索条件にしません。

すべての世代が検索対象になります。

2

STATUS

最新状態の世代を取得します。

検索対象となる世代は，ログインしているJP1/AJS3 - Managerの環境設定パラメーター「VIEWSTATUSRANGE」の設定値に従います。

環境設定パラメーター「VIEWSTATUSRANGE」と検索対象となる世代の優先度の詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」の検索ウィンドウの検索条件について記載している個所を参照してください。

3

RESULT

最新結果の世代を取得します。

4

PERIOD

指定した期間に存在する世代を取得します。

5

EXECID

指定した実行IDの世代を取得します。

(4)　UnitStatus

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchCondition のユニット状態を示します。

定数一覧

項番

定数名

説明

1

NO

検索条件にしない

2

UNREGISTERED

未登録

3

NOPLAN

未計画

4

UNEXEC

未実行終了

5

BYPASS

計画未実行

6

EXECDEFFER

繰越未実行

7

SHUTDOWN

閉塞

8

TIMEWAIT

開始時刻待ち

9

TERMWAIT

先行終了待ち

10

EXECWAIT

実行待ち

11

QUEUING

キューイング

12

CONDITIONWAIT

起動条件待ち

13

HOLDING

保留中

14

RUNNING

実行中

15

WACONT

警告検出実行中

16

ABCONT

異常検出実行中

17

MONITORING

監視中

18

ABNORMAL

異常検出終了

19

INVALIDSEQ

順序不正

20

INTERRUPT

中断

21

KILL

強制終了

22

FAIL

起動失敗

23

UNKNOWN

終了状態不正

24

MONITORCLOSE

監視打ち切り終了

25

WARNING

警告検出終了

26

NORMAL

正常終了

27

NORMALFALSE

正常終了−偽

28

UNEXECMONITOR

監視未起動終了

29

MONITORINTRPT

監視中断

30

MONITORNORMAL

監視正常終了

31

GRP_WAIT

開始待ち（開始時刻待ち，先行終了待ち，実行待ち，キューイング，起動条件待ち）

32

GRP_RUN

実行中（実行中，警告検出実行中，異常検出実行中，監視中）

33

GRP_ABNORMAL

異常終了（異常検出終了，順序不正，中断，強制終了，起動失敗，終了状態不明，監視打ち切り終了）

34

GRP_NORMAL

正常終了（正常終了，正常終了−偽，監視未起動終了，監視中断，監視正常終了）

(5)　DelayType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの開始遅延/終了遅延の指定有無を示します。

定数一覧

項番

定数名

説明

1

NO

遅延を検索条件にしない

2

START

開始遅延あり

3

END

終了遅延あり

4

YES

遅延あり（開始遅延あり，または終了遅延あり）

(6)　HoldAttr

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの保留状態を示します。

定数一覧

項番

定数名

説明

1

NO

保留予定を検索条件にしない

2

PLAN_NONE

保留予定なし

3

PLAN_YES

保留予定あり

(7)　MatchMethods

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの文字列の比較方法を示します。

定数一覧

項番

定数名

説明

1

NO

本項目は検索条件にしない

2

EQ

完全一致。検索条件の値と完全に一致する

3

BW

前方一致。検索条件の値で始まる

4

EW

後方一致。検索条件の値で終わる

5

NE

不一致。検索条件の値と一致しない

6

CO

含む。検索条件の値が含まれる

7

NC

含まない。検索条件の値が含まれない

8

RE

検索条件の値を正規表現として扱う。

正規表現については「表A-3 正規表現で指定できる記号および指定例」を参照してください。

表A‒3　正規表現で指定できる記号および指定例

記号

記号の意味

指定例

取得例

?

任意の一文字

A?

AB，A1，A？，A*，A¥

?E

DE，1E，？E，*E，¥E

*

任意の文字列

B*

B，BC，B12，B？*¥

¥

直後の記号を文字として扱う※

C¥?

C？だけ

注※　文字列の最後に指定するとエラーになります。

(8)　SearchTargetType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionの取得対象の範囲を示します。

定数一覧

項番

定数名

説明

1

DEFINITION

ユニットの定義だけを取得対象にする。

2

DEFINITION_AND_STATUS

ユニットの実行状態や世代数などを考慮して，ユニットの定義および状態を取得対象にする。

(9)　ReleaseInfoSearchMethods

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSearchCondition

説明

AjsCdSearchConditionのリリース情報の取得方法を示します。

定数一覧

項番

定数名

説明

1

NO

リリース情報を検索条件にしない

2

ID

リリースIDを検索条件にする

付録A.7　AjsCdSchServiceInfoの定数

AjsCdSchServiceInfoの定数について説明します。

(1)　DBType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdSchServiceInfo

説明

データベース構成を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

EMBDB

組み込みDB

4

ISAM

互換用ISAM構成

付録A.8　AjsCdAJSManagerInfoの定数

(1)　OSType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdAJSManagerInfo

説明

OS種別を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

WINDOWS

Windows

4

UNIX

UNIX/Linux

(2)　OSDetail

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdAJSManagerInfo

説明

OS詳細を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

WIN_2003

Windows Server 2003

4

WIN_2008

Windows Server 2008またはWindows Server 2012

5

AIX

AIX

6

HPUX

HP-UX

7

SOLARIS

Oracle Solaris

8

LINUX

Linux

(3)　OSArchitecture

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdAJSManagerInfo

説明

OSアーキテクチャを示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

X86

x86アーキテクチャ

4

IPF

IPFアーキテクチャ

5

OTHER

その他のアーキテクチャ

(4)　LinuxVersion

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdAJSManagerInfo

説明

Linux，RHELのバージョンを示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

V6

version 5またはversion 6

(5)　DBConfigType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdAJSManagerInfo

説明

データベース構成を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

STANDARD

標準構成

4

ISAM

互換用ISAM構成

5

INVALID

構成不正

付録A.9　AjsCdGetOptionの定数

(1)　GetHoldPlanType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdGetOption

説明

保留予定の有無の取得要否を示します。

定数一覧

項番

定数名

説明

1

HOLDPLAN_NO

保留予定の有無を取得しない。保留属性が設定されているかどうかに関係なく，「保留予定なし」を取得する。

2

HOLDPLAN_YES

次の条件を満たしている場合に「保留予定あり」を取得する。

対象となる実行世代に対して保留属性を設定している場合

3

HOLDPLAN_YES_CHANGES

次のどちらかの条件を満たしていいる場合に「保留予定あり」を取得する。

対象となる実行世代に対して保留属性を設定している場合

対象となる実行世代に対して保留属性を変更していない，かつユニットの属性で「保留する」を設定している場合

(2)　DateType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdGetOption

説明

取得開始終了日時の指定種別を示します。

定数一覧

項番

定数名

説明

1

CALENDAR_DATE

暦日

2

EXECUTION_DATE

実行日

付録A.10　AjsCdCalendarの定数

(1)　BaseType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdCalendar

説明

基準日の指定値を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

DAY

基準日は日付指定

4

WEEK

基準日は曜日指定

(2)　MonthType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdCalendar

説明

月区分を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

THIS

基準日以降の日は基準日の月（当月）

4

NEXT

基準日以降の日は翌月

(3)　WeekDay

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdCalendar

説明

曜日を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

SUNDAY

日曜日

4

MONDAY

月曜日

5

TUESDAY

火曜日

6

WEDNESDAY

水曜日

7

THURSDAY

木曜日

8

FRIDAY

金曜日

9

SATURDAY

土曜日

(4)　DayType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdCalendar

説明

運用日，休業日の情報を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

OPEN

運用日

4

CLOSED

休業日

付録A.11　AjsCdGetSummaryOptionの定数

(1)　SummaryType

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdGetSummaryOption

説明

サマリー情報取得時の取得情報の種類を示します。取得情報は次の要素で構成されます。

全体情報

取得対象となるユニットについて，サマリー情報全体インターフェース（AjsCdTotalSummary）で取得できる全世代分の情報です。

世代情報

取得対象となるユニットの各世代について，サマリー情報世代インターフェース（AjsCdSummaryInGeneration）で取得できる1世代分の情報です。

ユニット情報

取得対象となる各ユニットについて，ユニット情報インターフェース（AjsCdUnitInfo）で取得できるユニットの情報です。

定数一覧

項番

定数名

説明

1

WHOLE

全体情報だけを取得

2

GEN

全体情報と世代情報を取得※

3

ALL

すべての情報（全体情報，世代情報，およびユニット情報）を取得※

注※

取得対象となる世代が1つしか存在しない場合は，サマリー情報共通インターフェース（AjsCdJobnetSummary）による全体情報と世代情報の取得部分は同じになります。

付録A.12　AjsCdJobnetReleaseInfoの定数

(1)　ReleaseStatus

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.api.data.AjsCdJobnetReleaseInfo

説明

リリース状態を示します。

定数一覧

項番

定数名

説明

1

NONE

該当せず

2

UNSUPPORTED

未サポート

3

RELEASE_WAIT

リリース待ち

4

BEING_APPLIED

適用中

5

APPLIED

適用終了

6

DELETE_WAIT

削除待ち

7

RELEASE_ENTRY_WAIT

リリース登録待ち

付録A.13　AjsCdReturnCodeの定数

(1)　ReturnCode

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.common.AjsCdReturnCode

説明

リターンコード情報の終了コードを示します。

定数一覧

項番

定数名

説明

1

NORMAL

正常終了

2

ERROR_PARAM

パラメーターエラー

3

ERROR_SEQUENCE

シーケンスエラー

4

ERROR_FILEIO

ファイルアクセスエラー

5

ERROR_CONFIG

構成定義不正

6

ERROR_LOG

ログ出力エラー

7

ERROR_AJS_MANAGER

接続先JP1/AJS3のエラー

8

ERROR_PROTOCOL

プロトコル不正

9

NOTICE

通知

10

ERROR_CONNECT

通信エラー

11

ERROR_LOGIC

内部論理矛盾

(2)　DetailCode

含まれているクラス

jp.co.Hitachi.soft.jp1.ajs.cd.common.AjsCdReturnCode

説明

リターンコード情報の詳細コードを示します。

定数一覧

項番

定数名

説明

1

NONE

詳細コードなし

2

ERROR_PARAM_EMPTY

パラメーターエラー（未設定）

3

ERROR_PARAM_LENGTH

パラメーターエラー（バイト長不正）

4

ERROR_PARAM_RANGE

パラメーターエラー（数値範囲不正）

5

ERROR_PARAM_CHAR

パラメーターエラー（不正文字）

6

ERROR_PARAM_REGEXP

パラメーターエラー（正規表現不正）

7

ERROR_PARAM_FORMAT

パラメーターエラー（形式不正）

8

ERROR_PARAM_PERIOD

パラメーターエラー（期間不正）

9

ERROR_PARAM_UNSUPPORTED

パラメーターエラー（未サポート）

10

ERROR_PARAM_UNIT

パラメーターエラー（対象外のユニット）

11

ERROR_PARAM_MACRO_SIZE

パラメーターエラー（マクロ変数の個数不正）

12

ERROR_PARAM_MACRO_LENGTH

パラメーターエラー（マクロ変数の合計長不正）

13

ERROR_PARAM_INVCHARCODE

パラメーターエラー（文字コード不正）

14

ERROR_PARAM_DUPLICATE

パラメーターエラー（同時指定不不可）

15

ERROR_PARAM_UNITANDPARAM

パラメーターエラー（対象ユニットで指定できない値）

16

ERROR_PARAM_NEST_MAX

パラメーターエラー（最大ネスト数）

17

ERROR_PARAM_AUTHENTICATION

パラメーターエラー（認証情報不正）

18

ERROR_PARAM_EXIST_SCHEDULE

パラメーターエラー（すでに実行予定あり）

19

ERROR_PARAM_AUTHENTICATION_RELOGIN

認証情報不正（再ログイン）

20

ERROR_SEQUENCE_ALREADY_INITIALIZED

シーケンスエラー（すでに初期化済み）

21

ERROR_SEQUENCE_NOT_INITIALIZE

シーケンスエラー（初期化してない）

22

ERROR_SEQUENCE_ALREADY_LOGINED

シーケンスエラー（すでにログイン済み）

23

ERROR_SEQUENCE_NOT_LOGIN

シーケンスエラー（ログインしてない）

24

ERROR_FILEIO_NOT_FOUND

ファイルアクセスエラー（ファイルが見つからない）

25

ERROR_FILEIO_ACCESS

ファイルアクセスエラー（ファイルアクセスエラー）

26

ERROR_CONFIG_EMPTY

構成定義不正（未設定）

27

ERROR_CONFIG_LENGTH

構成定義不正（バイト長不正）

28

ERROR_CONFIG_RANGE

構成定義不正（数値範囲不正）

29

ERROR_CONFIG_UNSUPPORTED_ENCODING

構成定義不正（未サポートエンコード）

30

ERROR_CONFIG_NOT_FOLDER

構成定義不正（フォルダではない）

31

ERROR_CONFIG_FOLDER_NOT_FOUND

構成定義不正（フォルダが存在しない）

32

ERROR_CONFIG_NOT_SELECTABLE_VALUE

構成定義不正（選択可能な値ではない）

33

ERROR_CONFIG_KEY_EMPTY

構成定義不正（キー未設定）

34

ERROR_CONFIG_INVALID_FILE_PATH

構成定義不正（ファイルパス誤り）

35

ERROR_CONFIG_INVALID_HOME

構成定義不正（ホーム指定誤り）

36

ERROR_CONFIG_CHAR

構成定義不正（不正文字）

37

ERROR_LOG_INITIALIZATION_FAILURE

ログ出力エラー（初期化失敗）

38

ERROR_LOG_FINALIZATION_FAILURE

ログ出力エラー（終了処理失敗）

39

ERROR_LOG_FLUSH_FAILURE

ログ出力エラー（フラッシュ失敗）

40

ERROR_LOG_OUTPUT_FAILURE

ログ出力エラー（ログ出力失敗）

41

ERROR_PROTOCOL_UNSUPPORTED

プロトコル不正（未サポート要求）

42

NOTICE_CANCELED

通知（キャンセルされました）

43

ERROR_CONNECT_NOTCONN_HOST

通信エラー（ホストに接続できない）

44

ERROR_CONNECT_UNKNOWNHOST

通信エラー（ホスト名解決に失敗）

45

ERROR_CONNECT_NETERROR

通信エラー（通信障害）

46

ERROR_CONNECT_TIMEOUT_RES

通信エラー

（接続待ちタイムアウト）

47

ERROR_CONNECT_SESSION_CLIENT

通信エラー（クライアントでセッションエラー検出）

48

ERROR_CONNECT_SESSION_MANAGER

通信エラー（マネージャーでセッションエラー検出）

49

ERROR_CONNECT_ENCODE

通信エラー（エンコードエラー）

50

ERROR_CONNECT_INVALID_TOKEN

通信エラー（ログイン情報が無効）

51

ERROR_CONNECT_INVALID_RECEIVE_DATA

通信エラー（受信データ不正）

52

ERROR_LOGIC_UNKNOWN

内部論理矛盾（未知のエラー検出）

53

ERROR_LOGIC_MISSING_RESOURCE

内部論理矛盾（リソースバンドルが見つからない）

54

ERROR_LOGIC_CLASS_NOT_FOUND

内部論理矛盾（クラスが見つからない）

55

ERROR_LOGIC_CLONE_NOT_SUPPORTED

内部論理矛盾（クローン失敗）

56

ERROR_LOGIC_CLASS_NEW_INSTANCE

内部論理矛盾（クラスのインスタンス化に失敗）

付録B　接続先JP1/AJS3 - Managerの違いによる機能差異

JP1/AJS3 - SDKが接続するJP1/AJS3 - Managerの違いによる機能差異について説明します。

付録B.1　データベース構成の違いによる差異

JP1/AJS3 - SDK が接続するJP1/AJS3 - Managerのデータベースが互換用ISAM構成の場合，標準構成との機能差異の有無を，表B-1に示します。

表B‒1　データベースが互換用ISAM構成の場合の機能差異

項番

機能

クラス

メソッド

標準構成との機能差異

1

ログイン

AjsCdApi

login

なし

2

ログアウト

logout/logoutAll

なし

3

即時実行登録

registerImmediateExec

なし

4

計画実行登録

registerPlannedExec

なし

5

確定実行登録

registerFixedExec

なし

6

実行登録解除

cancelRegistration

なし

7

実行予定の追加

addExecSchedule

なし

8

実行開始予定日時の変更

changeStartTime

なし

9

一時的な即時実行

execImmediate

なし

10

実行中止

cancelExecSchedule

なし

11

実行開始予定日時の変更解除

restoreStartTime

なし

12

保留属性変更

changeHold

なし

13

遅延監視変更

changeDelayMonitor

なし

14

実行の中断

interrupt

なし

15

強制終了

kill

なし

16

再実行

rerun

なし

17

状態変更

changeStatus

なし

18

ユニット一覧の取得

searchUnit

あり

19

ユニット一覧取得の中止

cancelSearch

実行できない

20

詳細情報の取得

getUnitStatus

なし

21

実行結果詳細の取得

getExecResultDetails

なし

22

引き継ぎ結果の取得

getInheritResult

なし

23

スケジューラーサービスの一覧取得

enumSchService

なし

24

スケジューラーサービスの情報取得

getSchServiceInfo

なし

25

JP1/AJS3 - Managerの情報取得

getAJSManagerInfo

なし

26

変換用文字コードの設定・取得

setCharCode/getCharCode

なし

注意

上記以外のメソッドは互換用ISAM構成は未サポートとなります。

(1)　ユニット一覧の取得メソッドでの機能差異

JP1/AJS3 - SDK が接続するJP1/AJS3 - Managerのデータベースが互換用ISAM構成の場合，ユニット一覧の取得メソッド（searchUnitメソッド）の取得条件および取得情報について，標準構成との差異の有無を，表B-2および表B-3に示します。

表B‒2　データベースが互換用ISAM構成の場合の取得条件の差異

項番

取得条件

標準構成との差異の有無と内容

1

取得対象上位ユニット名

あり

「取得する世代」が「最新状態」「最新結果」の場合は「ジョブグループ」のみ指定可能。「取得する世代」が「実行ID」の場合は「ルートジョブネット」「ネストジョブネット」「起動条件」のみ指定可能。

2

取得対象

あり

取得条件の対象とならない（指定は無視される）。

3

取得範囲

あり

以下のユニットが検索結果に含まれる。

シナリオ管理グループ

以下のユニットが検索結果に含まれない。

起動条件

4

ユニット名

「完全一致」，「不一致」，「含む」，「含まない」の比較方法

あり

「完全一致」，「不一致」，「含む」，「含まない」を指定した場合，「前方一致」となる。

5

正規表現

なし

6

ユニット種別

全ユニット=検索条件としない

なし

7

ジョブグループのみ

なし

8

ルートジョブネットのみ

なし

9

ジョブネットのみ

あり

以下のユニットが検索結果に含まれる。

ジョブネットコネクタ

10

ジョブのみ

なし

11

取得する状態（世代）

検索条件としない

あり

取得条件として指定不可（最新状態が仮定される）。

12

最新状態

なし

13

最新結果

なし

14

期間指定

あり

取得条件として指定不可（最新状態が仮定される）。

15

実行ID

なし

16

状態

あり

グループ指定は不可（検索条件なしが仮定される）。

「検索条件なし」の場合，「取得する世代」にかかわらず，ユニットの定義による検索となる。

「未登録」の場合，以下のユニットが検索結果に含まれない。

ジョブグループ

マネージャーグループ

プランニンググループ

シナリオ管理グループ

17

遅延状態

開始遅延あり

あり

取得条件として指定不可（「開始遅延あり，または終了遅延あり」が仮定される）。

18

終了遅延あり

あり

取得条件として指定不可（「開始遅延あり，または終了遅延あり」が仮定される）。

19

開始遅延あり，または終了遅延あり

なし

20

保留状態

あり

取得条件の対象とならない（指定は無視される）。

21

コメント

あり

検索条件に指定した場合，比較方法は常に「含まれる」となる。

22

実行ホスト

あり

取得条件の対象とならない（指定は無視される）。

23

取得するリリース情報

リリースID

あり

取得条件の対象とならない（指定は無視される）。

表B‒3　データベースが互換用ISAM構成の場合の取得情報の差異

項番

標準構成での取得情報

互換用ISAM構成での取得可否

1

ユニット名称（完全名）

○

2

ユニット名称（単体名）

○

3

ユニットコメント

×

4

ユニット種別

×

5

カスタムジョブ種別

×

6

所有者

×

7

資源グループ

×

8

実行エージェント

×

9

実行ファイル名

×

10

実行パラメーター

×

11

登録状態

○※1

12

ユニットID

×

13

シナリオユニットかどうか

×

14

リカバリーユニットかどうか

×

15

ユニットの状態

ユニット名称（完全名）

○

16

ユニット名称（単体名）

○

17

実行ID

○※2

18

ユニットの状態

×

19

ルートジョブネット実行日の基準時刻

×

20

開始予定日時

×

21

開始日時

×

22

再実行開始日時

×

23

終了日時

×

24

自身の開始遅延有無

×

25

配下の開始遅延有無

×

26

自身の終了遅延有無

×

27

配下の終了遅延有無

×

28

開始遅延日時

×

29

終了遅延日時

×

30

計画一時変更の有無

×

31

保留属性（保留予定の元情報）

×

32

ジョブ登録日時

×

33

ジョブ番号

×

34

終了コード

×

35

実行ホスト名

×

36

保留予定

×

37

登録種別

×

38

起動条件の有効範囲の回数

×

39

起動条件の有効範囲の時間

×

40

起動条件の有効範囲の時間種別

×

41

リトライ状態

×

42

リトライ実行回数

×

43

サマリー用のユニット状態

×

44

リリース登録されているか

×

45

リリース情報

リリースID

×

46

リリース日時

×

47

リリースコメント

×

48

リリース状態

×

49

リリース元ジョブネット完全名

×

50

待ち合わせジョブかどうか

×

51

リトライ設定有無

×

52

最大リトライ回数

×

53

リトライ間隔

×

54

位置（X/Y座標）

×

凡例

○：取得可

×：取得不可（取得した場合，値は保証しません。）

注※1

「状態」に「NO（検索条件にしない）」を指定した場合：「登録状態」を取得できない場合があります（「UNSUPPORTED（未計画）」を取得）

注※2

「状態」に「NO（検索条件にしない）」を指定した場合：「実行ID」を取得できません

「状態」に「NOPLAN（未計画）」を指定した場合：「実行ID」を取得できない場合があります（空文字を取得）

(2)　キャンセル要求のメソッドでの機能差異

JP1/AJS3 - SDK が接続するJP1/AJS3 - Managerのデータベースが互換用ISAM構成の場合，キャンセル要求のメソッド（cancelSearchメソッド）は未サポートのため，例外を送出します。

付録C　メソッドで取得できるユニット情報の差異

メソッドで取得できるユニット情報の差異について，ユニット定義情報の差異を表C-1，ユニット状態/結果情報の差異を表C-2，リリース情報の差異を表C-3に示します。

表C‒1　取得できるユニット情報の差異（AjsCdUnitInfo）

項番

AjsCdUnitInfoの取得メソッド名

取得情報

メソッド名

情報を取得できない場合のデフォルト値

getCurrentStatusesUnderJobGroup

getDefinitionsUnderJobnet

getStatusesUnderJobnet

getSchedule

getJobnetSummary

searchUnit

1

getUnitName

ユニット名称（完全名）

○

○

×

×

○

○

""（空文字）

2

getSimpleUnitName

ユニット名称（単体名）

○

○

×

×

○

○

""（空文字）

3

getUnitComment

ユニットコメント

○

○

×

×

○

○

""（空文字）

4

getUnitType

ユニット種別

○

○

×

×

○

○

Type.NONE

5

getCustomJobType

カスタムジョブ種別

○

○

×

×

○

○

""（空文字）

6

getOwner

所有者

×

×

×

×

×

○

""（空文字）

7

getJP1ResourceGroup

資源グループ

×

×

×

×

×

○

""（空文字）

8

getExecAgent

実行エージェント

×

×

×

×

×

○

""（空文字）

9

getExecFileName

実行ファイル名

×

×

×

×

×

○

""（空文字）

10

getParameters

実行パラメーター

×

×

×

×

×

○

""（空文字）

11

getRegisterStatus

登録状態

○

×

×

×

×

○※2

RegisterStatus.NONE

12

getUnitID

ユニットID

×

○

○

○

○

○

-1

13

isScenarioUnit

シナリオユニットかどうか

○

○

×

×

○

○

FALSE

14

isRecoveryUnit

リカバリーユニットかどうか

○

○

×

×

×

○

FALSE

15

getUnitStatus

ユニットの状態※1

×

×

○

○

○

○※2

null

16

isJobnetReleaseUnit

リリース登録されているか

○

×

×

×

○

○

FALSE

17

getJobnetReleaseInfo

リリース情報※3

×

×

×

×

○

○

null

18

isWait

待ち合わせジョブかどうか

○

○

×

×

×

○

FALSE

19

isRetry

リトライ設定有無

×

○

×

×

×

○

FALSE

20

getMaximumRetryTimes

最大リトライ回数

×

×

×

×

×

○

-1

21

getRetryInterval

リトライ間隔

×

×

×

×

×

○

-1

22

getVerticalPosition/getHorizontalPosition

位置（X/Y座標）

×

○

×

×

×

×

-1

凡例

○：情報を取得します。

×：情報を取得しません（デフォルト値）。

−：対象外の項目です。

注※1

ユニットの状態は，「ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）」で取得します。詳細については，表C-2を参照してください。なお，ユニットが未登録の場合は状態はありません。

注※2

取得対象の範囲に「定義だけ」を指定した場合は，情報を取得しません（デフォルト値）。

注※3

ジョブネットリリース情報は，「リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）」で取得します。詳細については，表C-3を参照してください。なお，リリース登録されていない場合はリリース情報状態はありません。

表C‒2　取得できるユニット情報の差異（AjsCdUnitStatus）

項番

AjsCdUnitStatusの取得メソッド名

取得情報

メソッド名

情報を取得できない場合のデフォルト値

getCurrentStatusesUnderJobGroup※2

getStatusesUnderJobnet

getSchedule

getJobnetSummary

searchUnit

getUnitStatus

1

getUnitName

ユニット名称（完全名）

○

×

×

○

○

○

""（空文字）

2

getSimpleUnitName

ユニット名称（単体名）

○

×

×

○

○

○

""（空文字）

3

getExecID

実行ID

○

×

○※1 ※2

○※1

○

○

""（空文字）

4

getStatus

ユニットの状態

○

○※2

○※2

○

○

○

Status.NONE

5

getExecDateBaseTime

ルートジョブネット実行日の基準時刻

×

×

○

○

×

×

-1（long型）

6

getSchStartTime

開始予定日時

○

×

○※3 ※4

○※3

○

○

-1

7

getStartTime

開始日時

○

×

○※2 ※3

○※3

○

○

-1

8

getReStartTime

再実行開始日時

○

×

○※5

×

○

○

-1

9

getEndTime

終了日時

○

×

○※2

○

○

○

-1

10

getStartDelayStatus

自身の開始遅延有無

○

○※5

○※5

○

○

○

DelayStart.NONE

11

getNestStartDelayStatus

配下の開始遅延有無

○

○※6

○※6

○

○

○

DelayStart.NONE

12

getEndDelayStatus

自身の終了遅延有無

○

○※7

○※7

○

○

○

DelayEnd.NONE

13

getNestEndDelayStatus

配下の終了遅延有無

○

○※6

○※6

○

○

○

DelayEnd.NONE

14

getStartDelayTime

開始遅延日時

○

×

○※5

×

○

○

-1

15

getEndDelayTime

終了遅延日時

○

×

○※7

×

○

○

-1

16

getChangeType

計画一時変更の有無

○

×

○※8

×

○

○

ChangeType.NONE

17

getHoldAttr

保留属性（保留予定の元情報）※9

×

×

×

×

○

○

HoldAttr.NONE

18

getRegisterTime

ジョブ登録日時

×

×

×

×

○

○

-1

19

getJobNumber

ジョブ番号

×

×

×

×

○

○

0

20

getRetCode

終了コード

×

×

×

×

○

○

0

21

getExecHost

実行ホスト名

×

×

×

×

○

○

""（空文字）

22

getHoldPlan

保留予定※9

○

○

○

○

×※10

×

HoldPlan.NONE

23

getExecutionType

登録種別

○

×

○

×

×

×

ExecutionType.NONE

24

getStartConditionTimes

起動条件の有効範囲の回数

○

×

○

×

×

×

-1

25

getStartConditionPeriod

起動条件の有効範囲の時間

○

×

○

×

×

×

-1

26

getStartConditionPeriodType

起動条件の有効範囲の時間種別

○

×

○

×

×

×

TimeType.NONE

27

getRetryStatus

リトライ状態

×

○

○

×

×

×

RetryStatus.NONE

28

getRetryTimes

リトライ実行回数

×

○

○

×

○

×

0

29

getStatusInSummary

サマリー用のユニット状態

×

×

×

○

×

×

StatusInSummary.NONEを含むEnumSet型

凡例

○：情報を取得します。

×：情報を取得しません（デフォルト値）。

−：対象外の項目です。

注※1

擬似予定の場合は実行IDはありません。

注※2

グループ全般およびマネージャージョブネットの場合は参照できません。

注※3

開始日時は開始予定日時と開始日時から求めた開始日時になります。ジョブネットの場合だけ開始予定日時があります。

注※4

グループ全般，マネージャージョブネット，および.CONDITION（起動条件）の場合は参照できません。

注※5

ジョブネット（ネストジョブネットを含む）およびリモートジョブネット以外の場合は参照できません。

注※6

ジョブネット（ネストジョブネットを含む）以外の場合は参照できません。

注※7

グループ全般，マネージャージョブネット，ジョブネットコネクタ，ホストリンクジョブネット，ORジョブ，判定ジョブ，および.CONDITION（起動条件）の場合は参照できません。

注※8

グループ全般，マネージャージョブネット，ジョブネットコネクタ，ホストリンクジョブネット，および.CONDITION（起動条件）の場合は参照できません。

注※9

保留予定は保留属性から求めた保留の予定になります（求め方のオプションがあります）。

注※10

項番17の「保留属性」を取得するメソッドを使用してください。

表C‒3　取得できるユニット情報の差異（AjsCdJobnetReleaseInfo）

項番

AjsCdJobnetReleaseInfoの取得メソッド名

取得情報

メソッド名

情報を取得できない場合のデフォルト値

getJobnetSummary

searchUnit

getJobnetReleaseInfo

1

getReleaseID

リリースID

○

○

○

""（空文字）

2

getReleaseTime

リリース日時

×

○

○

-1

3

getUnitComment

リリースコメント

×

×

○

""（空文字）

4

getReleaseStatus

リリース状態

×

○

○

ReleaseStatus.NONE

5

getSourceUnitName

リリース元ジョブネット完全名

×

×

○

""（空文字）

凡例

○：情報を取得します。

×：情報を取得しません（デフォルト値）。

−：対象外の項目です。

付録D　（3021-3-119-10）の変更内容

（3021-3-119-10）での変更内容を次に示します。

表D‒1　（3021-3-119-10）の変更内容

項番

変更個所

追加・変更内容

1

表1-2，表1-5，3.3，3.9，3.10，3.11，3.12，3.13，3.14，3.15，3.16，3.17，3.18，3.19，3.20，3.21，3.22，3.23，3.24，3.25

データ型クラスに次のクラスおよびインターフェースを追加した。

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）

取得項目オプションクラス（AjsCdGetStatusDetailOption）

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）

関連線情報インターフェース（AjsCdUnitRelation）

予実績情報取得オプションクラス（AjsCdGetScheduleOption）

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）

世代単位の予実績情報インターフェース（AjsCdSchedule）

カレンダー情報インターフェース（AjsCdCalendar）

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）

サマリー情報共通インターフェース（AjsCdJobnetSummary）

サマリー情報全体インターフェース（AjsCdTotalSummary）

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）

2

表1-4，表2-3，2.3.24，2.3.25，2.3.26，2.3.27，2.3.28，2.3.29，2.3.30，2.3.31，2.3.32

API処理クラスのAjsCdApiインターフェースに次のメソッドを追加した。

getCurrentStatusesUnderJobGroupメソッド

getDefinitionsUnderJobnetメソッド

getStatusesUnderJobnetメソッド

getRelationsUnderJobnetメソッド

getScheduleメソッド

cancelGetScheduleメソッド

getCalendarメソッド

getJobnetSummaryメソッド

getJobnetReleaseInfoメソッド

3

表1-5，3.1，表3-1，3.1.2，3.1.12，3.1.16，3.1.17，3.1.18，3.1.19，3.1.20，3.1.21，3.1.22，3.1.23

データ型クラスのユニット情報インターフェース（AjsCdUnitInfo）に次のメソッドを追加した。

getSimpleUnitNameメソッド

getUnitIDメソッド

getHorizontalPositionメソッド

getVerticalPositionメソッド

getJobnetReleaseInfoメソッド

isWaitメソッド

isRetryメソッド

getMaximumRetryTimesメソッド

getRetryIntervalメソッド

isJobnetReleaseUnitメソッド

4

表1-5，3.2，表3-2，3.2.2，3.2.21，3.2.22，3.2.23，3.2.24，3.2.25，3.2.26，3.2.27，3.2.28，3.2.29

データ型クラスのユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）に次のメソッドを追加した。

getSimpleUnitNameメソッド

getHoldPlanメソッド

getExecutionTypeメソッド

getStartConditionTimesメソッド

getStartConditionPeriodメソッド

getStartConditionPeriodTypeメソッド

getRetryStatusメソッド

getRetryTimesメソッド

getStatusInSummaryメソッド

getExecDateBaseTimeメソッド

5

表1-5，表3-7，3.7.4，3.7.19，3.7.20，3.7.24，3.7.40，3.7.41

データ型クラスのユニット検索条件クラス（AjsCdSearchCondition）に次のメソッドを追加した。

setSearchTargetメソッド

setReleaseIDメソッド

setReleaseInfoSearchMethodsメソッド

getSearchTargetメソッド

getReleaseIDメソッド

getReleaseInfoSearchMethodsメソッド

6

表1-7

メソッド共通の制限値一覧に，引数に指定するリリースIDを追加しました。

7

3.2.6(1)

getStartTimeメソッドの説明を変更した。

8

3.2.8(1)

getEndTimeメソッドの説明を変更した。

9

3.7.8(4)

setUnitTypeメソッドの引数の説明を変更した。

10

5.3.3，5.3.4，5.3.5，5.3.6

次のメッセージの説明を変更した。

KNAK0201-E

KNAK0401-E

KNAK0415-E

KNAK0556-E

KNAK1123-E

11

5.3.4，5.3.6

次のメッセージを追加した。

KNAK0463-E

KNAK1127-E

KNAK1128-E

KNAK1129-E

KNAK1130-E

KNAK1131-E

KNAK1132-E

KNAK1133-E

12

表A-1，付録A.3(6)，付録A.3(7)，付録A.3(8)，付録A.3(9)，付録A.3(10)

データ型クラスのユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）に次の定数を追加した。

HoldPlan

ExecutionType

TimeType

RetryStatus

StatusInSummary

13

表A-1，付録A.4，付録A.9，付録A.10，付録A.11，付録A.12

次の定数を追加した。

AjsCdUnitRelationの定数

AjsCdGetOptionの定数

AjsCdCalendarの定数

AjsCdGetSummaryOptionの定数

AjsCdJobnetReleaseInfoの定数

14

表A-1，付録A.6(8)，付録A.6(9)

データ型クラスのユニット検索条件クラス（AjsCdSearchCondition）に次の定数を追加した。

SearchTargetType

ReleaseInfoSearchMethods

15

付録A.6(3)

データ型クラスのユニット検索条件クラス（AjsCdSearchCondition）に次の定数一覧に「NO」を追加した。

GenerationType

16

付録A.8(2)

定数名「WIN_2008」にWindows Server 2012を追加した。

17

付録A.8(4)

定数名「V6」にversion 5を追加した。

18

表B-2

データベースが互換用ISAM構成の場合の取得条件の差異について，次の取得条件を追加した。

取得対象

取得するリリース情報

19

表B-2

データベースが互換用ISAM構成の場合の取得条件の差異について，取得する状態（世代）に「検索条件としない」を追加した。

20

表B-3

データベースが互換用ISAM構成の場合の取得情報の差異について，次の項目を追加した。

ユニット名称（完全名）

ユニット名称（単体名）

ユニットコメント

カスタムジョブ種別

所有者

資源グループ

登録状態

ユニットID

シナリオユニットかどうか

リカバリーユニットかどうか

ユニットの状態

リリース登録されているか

リリース情報

待ち合わせジョブかどうか

リトライ設定有無

最大リトライ回数

リトライ間隔

位置（X/Y座標）

21

付録C

メソッドで取得できるユニット情報の差異の説明を追加した。

22

−

次のOSをサポート対象とした。

Windows 8

Windows Server 2012

付録E　このマニュアルの参考情報

このマニュアルを読むに当たっての参考情報を示します。

付録E.1　関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

JP1/AJS3関連

JP1 Version 10 JP1/Automatic Job Management System 3 入門（3021-3-101）

JP1 Version 10 JP1/Automatic Job Management System 3 導入ガイド（3021-3-102）

JP1 Version 10 JP1/Automatic Job Management System 3 設計ガイド（システム構築編）（3021-3-103）

JP1 Version 10 JP1/Automatic Job Management System 3 設計ガイド（業務設計編）（3021-3-104）

JP1 Version 10 JP1/Automatic Job Management System 3 構築ガイド1（3021-3-105）

JP1 Version 10 JP1/Automatic Job Management System 3 構築ガイド2（3021-3-106）

JP1 Version 10 JP1/Automatic Job Management System 3 運用ガイド（3021-3-107）

JP1 Version 10 JP1/Automatic Job Management System 3 トラブルシューティング（3021-3-108）

JP1 Version 10 JP1/Automatic Job Management System 3 操作ガイド（3021-3-109）

JP1 Version 10 JP1/Automatic Job Management System 3 コマンドリファレンス1（3021-3-110）

JP1 Version 10 JP1/Automatic Job Management System 3 コマンドリファレンス2（3021-3-111）

JP1 Version 10 JP1/Automatic Job Management System 3 連携ガイド（3021-3-112）

JP1 Version 10 JP1/Automatic Job Management System 3 メッセージ1（3021-3-113）

JP1 Version 10 JP1/Automatic Job Management System 3 メッセージ2（3021-3-114）

JP1 Version 10 JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド（3021-3-118）

JP1関連

JP1 Version 10 JP1/Base 運用ガイド（3021-3-001）

JP1 Version 10 JP1/Base メッセージ（3021-3-002）

JP1/AJS2 - Manager for Mainframe関連

JP1 Version 8 JP1/Automatic Job Management System 2 メインフレーム 運用・操作編（3023-3-K52）

付録E.2　このマニュアルでの表記

このマニュアルでは，日立製品およびその他の製品の名称を省略して表記しています。また，英略語を使用しています。このマニュアルでの表記と正式名称を次に示します。

このマニュアルでの表記

正式名称

JP1/AJS3

JP1/AJS3 - Manager

JP1/Automatic Job Management System 3 - Manager

JP1/AJS3 - Agent

JP1/Automatic Job Management System 3 - Agent

JP1/AJS3 - View

JP1/Automatic Job Management System 3 - View

JP1/AJS2 - Manager for Mainframe

JP1/Automatic Job Management System 2 - Manager for Mainframe

JP1/AJS2 - Scenario Operation

JP1/Automatic Job Management System 2 - Scenario Operation

JP1/IM - Planning Operation

JP1/Integrated Management - Planning Operation

付録E.3　このマニュアルで使用する英略語

このマニュアルで使用する英略語を次に示します。

英略語

正式名称

API

Application Programming Interface

DB

Database

HTTP

Hyper Text Transfer Protocol

IP

Internet Protocol

IPF

Itanium(R) Processor Family

ISAM

Indexed Sequential Access Method

JIS

Japanese Industrial Standard code

JVM

Java Virtual Machine

OS

Operating System

PC

Personal Computer

RHEL

Red Hat Enterprise Linux

UCS

Universal Multiple-Octet Coded Character Set

UTC

Universal Time Coordinated

UTF

UCS Transformation Format

索引

A

addExecScheduleメソッド[1]

addMacroVariableメソッド[1]

AjsCdAJSManagerException例外クラス[1]、[2]

AjsCdAJSManagerException例外クラスのメソッド一覧[1]

AjsCdAJSManagerInfoの定数[1]

AjsCdApiCancelException例外クラス[1]、[2]

AjsCdApiCancelException例外クラスのメソッド一覧[1]

AjsCdApiException例外クラス[1]、[2]

AjsCdApiException例外クラスのメソッド一覧[1]

AjsCdApiParameterException例外クラス[1]、[2]

AjsCdApiParameterException例外クラスのメソッド一覧[1]

AjsCdApiSequenceException例外クラス[1]、[2]

AjsCdApiSequenceException例外クラスのメソッド一覧[1]

AjsCdApiインターフェース[1]、[2]

AjsCdApiインターフェースのメソッド一覧[1]

AjsCdCalendarの定数[1]

AjsCdException例外クラス[1]、[2]

AjsCdException例外クラスのメソッド一覧[1]

AjsCdFactoryクラス[1]、[2]

AjsCdFactoryクラスのメソッド一覧[1]

AjsCdGetOptionの定数[1]

AjsCdGetSummaryOptionの定数[1]

AjsCdInvalidTokenException例外クラス[1]、[2]

AjsCdInvalidTokenException例外クラスのメソッド一覧[1]

AjsCdJobnetReleaseInfoの定数[1]

AjsCdOperationの定数[1]

AjsCdReturnCodeクラス[1]、[2]

AjsCdReturnCodeクラスのメソッド一覧[1]

AjsCdReturnCodeの定数[1]

AjsCdSchServiceInfoの定数[1]

AjsCdSearchConditionの定数[1]

AjsCdStartConditionの定数[1]

AjsCdUnitInfoの定数[1]

AjsCdUnitRelationの定数[1]

AjsCdUnitStatusの定数[1]

AjsCdインターフェース[1]、[2]

AjsCdインターフェースのメソッド一覧[1]

API処理クラス[1]、[2]

API処理クラスのクラス/インターフェース一覧[1]

API処理クラスのメソッド一覧[1]

APIの記述形式[1]

B

BaseType（AjsCdCalendarの定数）[1]

C

cancelExecScheduleメソッド[1]

cancelGetScheduleメソッド[1]

cancelRegistrationメソッド[1]

cancelSearchメソッド[1]

changeDelayMonitorメソッド[1]

ChangeHoldAttr（AjsCdOperationの定数）[1]

changeHoldメソッド[1]

ChangeLowerType（AjsCdOperationの定数）[1]

ChangePushedAheadType（AjsCdOperationの定数）[1]

ChangeStartTimeType（AjsCdOperationの定数）[1]

changeStartTimeメソッド[1]

ChangeStatus（AjsCdOperationの定数）[1]

changeStatusメソッド[1]

ChangeType（AjsCdUnitStatusの定数）[1]

createAjsCdApiメソッド[1]

createAjsCdGetCurrentStatusesUnderJobGroupOptionメソッド[1]

createAjsCdGetScheduleOptionメソッド[1]

createAjsCdGetStatusDetailOptionメソッド[1]

createAjsCdGetStatusesUnderJobnetOptionメソッド[1]

createAjsCdGetSummaryOptionメソッド[1]

createAjsCdMacroVariableListメソッド[1]

createAjsCdSearchConditionメソッド[1]

createAjsCdStartConditionメソッド[1]

createAjsCdメソッド[1]

D

DateType（AjsCdGetOptionの定数）[1]

DayType（AjsCdCalendarの定数）[1]

DBConfigType（AjsCdAJSManagerInfoの定数）[1]

DBType（AjsCdSchServiceInfoの定数）[1]

DelayEnd（AjsCdUnitStatusの定数）[1]

DelayMonitorType（AjsCdOperationの定数）[1]

DelayStart（AjsCdUnitStatusの定数）[1]

DelayType（AjsCdSearchConditionの定数）[1]

destroyAjsCdApiメソッド[1]

destroyAjsCdメソッド[1]

DestroyOption（AjsCdOperationの定数）[1]

DetailCode（AjsCdReturnCodeの定数）[1]

E

enumSchServiceメソッド[1]

execImmediateメソッド[1]

ExecutionType（AjsCdUnitStatusの定数）[1]

G

GenerationType（AjsCdSearchConditionの定数）[1]

getAbnormalCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getAjsCdApiメソッド[1]

getAjsCdメソッド[1]

getAJSManagerInfoメソッド[1]

getBaseDateメソッド[1]

getBaseDayメソッド[1]

getBaseTimeメソッド[1]

getBaseTypeメソッド[1]

getBaseWeekメソッド[1]

getCalendarメソッド[1]

getCauseメソッド[1]

getChangeTypeメソッド[1]

getCharCodeメソッド（AjsCdApiインターフェース）[1]

getCharCodeメソッド（スケジューラーサービス情報インターフェース）[1]

getCurrentStatusesUnderJobGroupメソッド（AjsCdApiインターフェース）[1]

getCurrentStatusesUnderJobGroupメソッド（ジョブグループ直下ユニット取得結果インターフェース）[1]

getCustomJobTypeメソッド[1]

getDayListメソッド[1]

getDBConfigメソッド[1]

getDBTypeメソッド[1]

getDefinitionsUnderJobnetメソッド[1]

getDeflenTypeメソッド[1]

getDelayCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getDelayStatusメソッド[1]

getDetailCodeメソッド[1]

getEndDelayStatusメソッド[1]

getEndDelayTimeメソッド[1]

getEndTimeメソッド[1]

getExecAgentメソッド[1]

getExecDateBaseTimeメソッド[1]

getExecFileNameメソッド[1]

getExecHostMatchMethodsメソッド[1]

getExecHostメソッド（ユニット検索条件クラス）[1]

getExecHostメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getExecIDメソッド（サマリー情報世代インターフェース）[1]

getExecIDメソッド（ユニット検索条件クラス）[1]

getExecIDメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getExecResultDetailsメソッド[1]

getExecutionTypeメソッド[1]

getFirstExecutionTimeメソッド[1]

getFirstExecutionTimeメソッド（予実績情報取得オプションクラス）[1]

getGenerationNumberメソッド[1]

getGenerationメソッド[1]

getGetHoldPlanTypeメソッド（サマリー情報取得オプションクラス）[1]

getGetHoldPlanTypeメソッド（ジョブグループ直下ユニット取得オプションクラス）[1]

getGetHoldPlanTypeメソッド（ジョブネット直下ユニット状態取得オプションクラス）[1]

getGetHoldPlanTypeメソッド（予実績情報取得オプションクラス）[1]

getHoldAttrメソッド（ユニット検索条件クラス）[1]

getHoldAttrメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getHoldCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

GetHoldPlanType（AjsCdGetOptionの定数）[1]

getHoldPlanメソッド[1]

getHorizontalPositionメソッド[1]

getInheritResultメソッド[1]

getInstanceメソッド[1]

getJobnetReleaseInfoメソッド（AjsCdApiインターフェース）[1]

getJobnetReleaseInfoメソッド（ユニット情報インターフェース）[1]

getJobnetSummaryメソッド[1]

getJobNumberメソッド[1]

getJP1ResourceGroupメソッド[1]

getLinuxVersionメソッド[1]

getMacroVariableListメソッド[1]

getManagerメソッド[1]

getMaximumRetryTimesメソッド[1]

getMessageメソッド[1]

getMonthTypeメソッド[1]

getNameメソッド[1]

getNestEndDelayStatusメソッド[1]

getNestStartDelayStatusメソッド[1]

getNormalCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getOSArchitectureメソッド[1]

getOSDetailメソッド[1]

getOSTypeメソッド[1]

getOwnerメソッド[1]

getParametersメソッド[1]

getPeriodBeginメソッド[1]

getPeriodEndメソッド[1]

getPeriodTypeメソッド[1]

getPeriodメソッド[1]

getPrecedingメソッド[1]

getRegisterStatusメソッド[1]

getRegisterTimeメソッド[1]

getRelationsUnderJobnetメソッド[1]

getRelationTypeメソッド[1]

getReleaseCommentメソッド[1]

getReleaseIDメソッド（ユニット検索条件クラス）[1]

getReleaseIDメソッド（リリース情報取得結果インターフェース）[1]

getReleaseInfoSearchMethodsメソッド[1]

getReleaseStatusメソッド[1]

getReleaseTimeメソッド[1]

getReStartTimeメソッド[1]

getResultInfoメソッド[1]

getResultItemメソッド[1]

getResultMaxメソッド[1]

getRetCodeメソッド[1]

getRetryIntervalメソッド[1]

getRetryStatusメソッド[1]

getRetryTimesメソッド[1]

getReturnCodeメソッド（AjsCdExcepiton，AjsCdAJSManagerException，AjsCdInvalidTokenException，AjsCdApiParameterException，AjsCdApiSequenceException，AjsCdApiCancelException，AjsCdApiException）[1]

getReturnCodeメソッド（AjsCdReturnCode）[1]

getRunCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getScheduleCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getScheduleInGenerationListメソッド[1]

getScheduleメソッド[1]

getSchEndTimeメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getSchServiceInfoメソッド[1]

getSchStartTimeメソッド[1]

getSearchLocationメソッド[1]

getSearchLowerUnitsメソッド[1]

getSearchTargetメソッド[1]

getServiceNameメソッド[1]

getSimpleUnitNameメソッド（ユニット情報インターフェース）[1]

getSimpleUnitNameメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getSourceUnitNameメソッド[1]

getStartConditionPeriodTypeメソッド[1]

getStartConditionPeriodメソッド[1]

getStartConditionTimesメソッド[1]

getStartDayメソッド[1]

getStartDelayStatusメソッド[1]

getStartDelayTimeメソッド[1]

getStartTimeメソッド[1]

getStatusesUnderJobnetメソッド[1]

getStatusInfoメソッド[1]

getStatusInSummaryメソッド[1]

getStatusItemメソッド[1]

getStatusメソッド（ユニット検索条件クラス）[1]

getStatusメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getSucceedingメソッド[1]

getSummaryInGenerationListメソッド[1]

getTimesメソッド[1]

getTypeメソッド[1]

getUnitCommentMatchMethodsメソッド[1]

getUnitCommentメソッド（ユニット検索条件クラス）[1]

getUnitCommentメソッド（ユニット情報インターフェース）[1]

getUnitIDメソッド[1]

getUnitInfoメソッド（サマリー情報世代インターフェース）[1]

getUnitInfoメソッド（ジョブグループ直下ユニット情報インターフェース）[1]

getUnitInfoメソッド（ジョブネット直下ユニット状態情報取得結果インターフェース）[1]

getUnitInfoメソッド（ジョブネット直下ユニット定義情報取得結果インターフェース）[1]

getUnitInfoメソッド（世代単位の予実績情報インターフェース）[1]

getUnitInfoメソッド（ユニット検索結果インターフェース）[1]

getUnitNameMatchMethodsメソッド[1]

getUnitNameメソッド（ユニット検索条件クラス）[1]

getUnitNameメソッド（ユニット情報インターフェース）[1]

getUnitNameメソッド（ユニットの実行状態および実行結果の詳細情報インターフェース）[1]

getUnitRelationListメソッド[1]

getUnitStatusメソッド（AjsCdApiインターフェース）[1]

getUnitStatusメソッド（ユニット情報インターフェース）[1]

getUnitTypeメソッド（ユニット検索条件クラス）[1]

getUnitTypeメソッド（ユニット情報インターフェース）[1]

getUserNameメソッド[1]

getValueメソッド[1]

getVersionメソッド[1]

getVerticalPositionメソッド[1]

getWaitCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

getWarningCountメソッド（サマリー情報共通インターフェース，サマリー情報全体インターフェース，サマリー情報世代インターフェース）[1]

H

HoldAttr（AjsCdSearchConditionの定数）[1]

HoldAttr（AjsCdUnitStatusの定数）[1]

HoldPlan（AjsCdUnitStatusの定数）[1]

I

interruptメソッド[1]

isAllメソッド[1]

isGetChangeTypeOptionメソッド（取得項目オプションクラス）[1]

isGetChangeTypeOptionメソッド（予実績情報取得オプションクラス）[1]

isGetEndDelayOptionメソッド[1]

isGetEndTimeOptionメソッド[1]

isGetExecutionTypeOptionメソッド[1]

isGetStartConditionOptionメソッド（取得項目オプションクラス）[1]

isGetStartConditionOptionメソッド（予実績情報取得オプションクラス）[1]

isGetStartDelayOptionメソッド[1]

isGetStartTimeOptionメソッド[1]

isJobnetReleaseUnitメソッド[1]

isOperationNetメソッド[1]

isRecoveryUnitメソッド[1]

isRetryメソッド[1]

isScenarioUnitメソッド[1]

isSimulationメソッド[1]

isWaitメソッド[1]

J

JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）[1]、[2]

JP1/AJS3 - Manager情報インターフェース（AjsCdAJSManagerInfo）のメソッド一覧[1]

K

killメソッド[1]

KNAK0001〜KNAK0100[1]

KNAK0101〜KNAK0200[1]

KNAK0201〜KNAK0250[1]

KNAK0401〜KNAK0500[1]

KNAK0501〜KNAK1000[1]

KNAK1001〜KNAK1500[1]

KNAK1501〜KNAK1600[1]

KNAK1601〜KNAK1700[1]

L

LinuxVersion（AjsCdAJSManagerInfoの定数）[1]

loginメソッド[1]

logoutAllメソッド[1]

logoutメソッド[1]

LowerType（AjsCdSearchConditionの定数）[1]

M

MatchMethods（AjsCdSearchConditionの定数）[1]

MonthType（AjsCdCalendarの定数）[1]

O

OSArchitecture（AjsCdAJSManagerInfoの定数）[1]

OSDetail（AjsCdAJSManagerInfoの定数）[1]

OSType（AjsCdAJSManagerInfoの定数）[1]

P

PlannedTimePassedType（AjsCdOperationの定数）[1]

R

registerFixedExecメソッド[1]

registerImmediateExecメソッド[1]

registerPlannedExecメソッド[1]

RegisterStatus（AjsCdUnitInfoの定数）[1]

RelationType（AjsCdUnitRelationの定数）[1]

ReleaseInfoSearchMethods（AjsCdSearchConditionの定数）[1]

ReleaseStatus（AjsCdJobnetReleaseInfoの定数）[1]

RerunOption（AjsCdOperationの定数）[1]

RerunType（AjsCdOperationの定数）[1]

rerunメソッド[1]

restoreStartTimeメソッド[1]

RetryStatus（AjsCdUnitStatusの定数）[1]

ReturnCode（AjsCdReturnCodeの定数）[1]

RootRerunType（AjsCdOperationの定数）[1]

S

SearchTargetType（AjsCdSearchConditionの定数）[1]

searchUnitメソッド[1]

setCharCodeメソッド[1]

setDelayStatusメソッド[1]

setExecHostMatchMethodsメソッド[1]

setExecHostメソッド[1]

setExecIDメソッド[1]

setFirstExecutionTimeメソッド（サマリー情報取得オプションクラス）[1]

setFirstExecutionTimeメソッド（予実績情報取得オプションクラス）[1]

setGenerationメソッド[1]

setGetChangeTypeOptionメソッド（取得項目オプションクラス）[1]

setGetChangeTypeOptionメソッド（予実績情報取得オプションクラス）[1]

setGetEndDelayOptionメソッド[1]

setGetEndTimeOptionメソッド[1]

setGetExecutionTypeOptionメソッド[1]

setGetHoldPlanTypeメソッド（サマリー情報取得オプションクラス）[1]

setGetHoldPlanTypeメソッド（ジョブグループ直下ユニット取得オプションクラス）[1]

setGetHoldPlanTypeメソッド（ジョブネット直下ユニット状態取得オプションクラス）[1]

setGetHoldPlanTypeメソッド（予実績情報取得オプションクラス）[1]

setGetStartConditionOptionメソッド（取得項目オプションクラス）[1]

setGetStartConditionOptionメソッド（予実績情報取得オプションクラス）[1]

setGetStartDelayOptionメソッド[1]

setGetStartTimeOptionメソッド[1]

setHoldAttrメソッド[1]

setPeriodBeginメソッド[1]

setPeriodEndメソッド[1]

setPeriodTypeメソッド[1]

setPeriodメソッド[1]

setReleaseIDメソッド[1]

setReleaseInfoSearchMethodsメソッド[1]

setResultItemメソッド[1]

setResultMaxメソッド[1]

setSearchLocationメソッド[1]

setSearchLowerUnitsメソッド[1]

setSearchTargetメソッド[1]

setSimulationメソッド[1]

setStatusItemメソッド[1]

setStatusメソッド[1]

setTimesメソッド[1]

setTypeメソッド[1]

setUnitCommentMatchMethodsメソッド[1]

setUnitCommentメソッド[1]

setUnitNameMatchMethodsメソッド[1]

setUnitNameメソッド[1]

setUnitTypeメソッド[1]

Status（AjsCdUnitStatusの定数）[1]

StatusInSummary（AjsCdUnitStatusの定数）[1]

SummaryType（AjsCdGetSummaryOptionの定数）[1]

T

TimeType（AjsCdStartConditionの定数）[1]

TimeType（AjsCdUnitStatusの定数）[1]

Type（AjsCdUnitInfoの定数）[1]

U

UnitStatus（AjsCdSearchConditionの定数）[1]

UnitType（AjsCdSearchConditionの定数）[1]

W

WeekDay（AjsCdCalendarの定数）[1]

い

インターフェース[1]

か

各メソッドの引数の注意事項[1]

カレンダー情報インターフェース（AjsCdCalendar）[1]、[2]

カレンダー情報インターフェース（AjsCdCalendar）のメソッド一覧[1]

関連線情報インターフェース（AjsCdUnitRelation）[1]、[2]

関連線情報インターフェース（AjsCdUnitRelation）のメソッド一覧[1]

き

起動条件クラス（AjsCdStartCondition）[1]、[2]

起動条件クラス（AjsCdStartCondition）のメソッド一覧[1]

く

クラス[1]

さ

サマリー情報共通インターフェース（AjsCdJobnetSummary）[1]、[2]

サマリー情報共通インターフェース（AjsCdJobnetSummary）のメソッド一覧[1]

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）[1]、[2]

サマリー情報取得オプションクラス（AjsCdGetSummaryOption）のメソッド一覧[1]

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）[1]、[2]

サマリー情報世代インターフェース（AjsCdSummaryInGeneration）のメソッド一覧[1]

サマリー情報全体インターフェース（AjsCdTotalSummary）[1]、[2]

サマリー情報全体インターフェース（AjsCdTotalSummary）のメソッド一覧[1]

し

取得項目オプションクラス（AjsCdGetStatusDetailOption）[1]、[2]

取得項目オプションクラス（AjsCdGetStatusDetailOption）のメソッド一覧[1]

取得できるユニット情報の差異（AjsCdJobnetReleaseInfo）[1]

取得できるユニット情報の差異（AjsCdUnitInfo）[1]

取得できるユニット情報の差異（AjsCdUnitStatus）[1]

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）[1]、[2]

ジョブグループ直下ユニット取得オプションクラス（AjsCdGetCurrentStatusesUnderJobGroupOption）のメソッド一覧[1]

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）[1]、[2]

ジョブグループ直下ユニット取得結果インターフェース（AjsCdGetCurrentStatusesUnderJobGroupResult）のメソッド一覧[1]

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）[1]、[2]

ジョブグループ直下ユニット情報インターフェース（AjsCdCurrentStatusesUnderJobGroup）のメソッド一覧[1]

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）[1]、[2]

ジョブネット直下関連線情報取得結果インターフェース（AjsCdGetRelationsUnderJobnetResult）のメソッド一覧[1]

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）[1]、[2]

ジョブネット直下ユニット状態取得オプションクラス（AjsCdGetStatusesUnderJobnetOption）のメソッド一覧[1]

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）[1]、[2]

ジョブネット直下ユニット状態情報取得結果インターフェース（AjsCdGetStatusesUnderJobnetResult）のメソッド一覧[1]

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）[1]、[2]

ジョブネット直下ユニット定義情報取得結果インターフェース（AjsCdGetDefinitionsUnderJobnetResult）のメソッド一覧[1]

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）[1]、[2]

ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）のメソッド一覧[1]

す

スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）[1]、[2]

スケジューラーサービス情報インターフェース（AjsCdSchServiceInfo）のメソッド一覧[1]

スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）[1]、[2]

スケジューラーサービス定義インターフェース（AjsCdSchServiceDef）のメソッド一覧[1]

せ

世代単位の予実績情報インターフェース（AjsCdSchedule）[1]、[2]

世代単位の予実績情報インターフェース（AjsCdSchedule）のメソッド一覧[1]

接続先JP1/AJS3 - Managerの違いによる機能差異[1]

て

定数[1]

データ型クラス[1]、[2]

データ型クラスのクラス/インターフェース一覧[1]

データ型クラスのメソッド一覧[1]

データ型クラスの列挙型定数の一覧[1]

データベースが互換用ISAM構成の場合の機能差異[1]

データベースが互換用ISAM構成の場合の取得条件の差異[1]

データベースが互換用ISAM構成の場合の取得情報の差異[1]

ま

マクロ変数インターフェース（AjsCdMacroVariable）[1]、[2]

マクロ変数インターフェース（AjsCdMacroVariable）のメソッド一覧[1]

マクロ変数リストクラス（AjsCdMacroVariableList）[1]、[2]

マクロ変数リストクラス（AjsCdMacroVariableList）のメソッド一覧[1]

め

メソッド[1]

メソッド共通の制限値[1]

メソッドで取得できるユニット情報の差異[1]

メッセージ一覧[1]

メッセージの記載形式[1]

メッセージの形式[1]

メッセージの出力形式[1]

メッセージの出力先[1]

メッセージの分類[1]

も

文字コード変換に使用するスケジューラーサービスの文字コード[1]

ゆ

ユニット検索結果インターフェース（AjsCdSearchResult）[1]、[2]

ユニット検索結果インターフェース（AjsCdSearchResult）のメソッド一覧[1]

ユニット検索条件クラス（AjsCdSearchCondition）[1]、[2]

ユニット検索条件クラス（AjsCdSearchCondition）のメソッド一覧[1]

ユニット情報インターフェース（AjsCdUnitInfo）[1]、[2]

ユニット情報インターフェース（AjsCdUnitInfo）のメソッド一覧[1]

ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）[1]、[2]

ユニットの実行状態および実行結果の詳細情報インターフェース（AjsCdUnitStatus）のメソッド一覧[1]

よ

予実績情報取得オプションクラス（AjsCdGetScheduleOption）[1]、[2]

予実績情報取得オプションクラス（AjsCdGetScheduleOption）のメソッド一覧[1]

り

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）[1]、[2]

リリース情報取得結果インターフェース（AjsCdJobnetReleaseInfo）のメソッド一覧[1]

れ

例外クラス[1]、[2]

例外クラスのクラス一覧[1]

例外クラスのメソッド一覧[1]

例外クラスの列挙型定数の一覧[1]