Hitachi

JP1 Version 10 JP1/Automatic Job Management System 3 - Software Development Kit 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のデータベース構成の取得