jp.co.slcs.kaiden.v2.base.foundation.job

クラス AbstractExtExportJob<SETTINGS extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF<?,?>,JPR extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_jop_process_result.GenericJobProcessResult>

java.lang.Object

jp.co.slcs.kaiden.v2.base.foundation.job.AbstractExtExportJob<SETTINGS,JPR>

型パラメータ:

SETTINGS - エクスポート設定

JPR - ジョブ処理実行結果の型

すべての実装されたインタフェース:

jp.co.intra_mart.foundation.job_scheduler.Job

直系の既知のサブクラス:

AbstractFbdataExportJob, DailyWorkDataExportJob, SalaryDataExportJob

public abstract class AbstractExtExportJob<SETTINGS extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF<?,?>,JPR extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_jop_process_result.GenericJobProcessResult>
extends Object

皆伝！JobSchedulerで使用する拡張版Exportの抽象クラス.

作成者:

Sumitomo Life Information Systems Co.,Ltd.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	AbstractExtExportJob.Constans Exporterで利用する各種定数値.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected List<String>	companyList 会社コードリスト.
protected CompanyManagerHelper	companyManagerHelper CompanyManagerHelper.
protected ContextHelper	contextHelper ContextHelper.
protected DateHelper	dateHelper DateHelper.
protected boolean	eachCompanyModeFlag 会社単位処理モードフラグ.
protected int	errorCount 異常データ件数.
protected ErrorMode	errorMode エラー時処理続行制御.
protected SETTINGS	exportSettings export設定.
protected ExtExportHelper	extExportHelper ExtExportHelper.
protected JPR	jobProcessResult 汎用処理結果出力XML.
protected LockHelper	lockHelper LockHelper.
protected int	normalCount 正常データ件数.
protected String	processingCompanyCd 処理中会社コード.
protected String	processTargetCompanyCd 処理対象会社コード.
protected PropertyHelper	propertyHelper PropertyHelper.
protected SystemLocaleHelper	systemLocaleHelper SystemLocaleHelper.
protected TransactionHelper	transactionHelper TransactionHelper.
protected Map<String,KaidenValidateExecutorForJob>	validateMap バリデート実行クラス格納Map.
protected XmlOutputHelper	xmlOutputHelper XmlOutputHelper.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AbstractExtExportJob(KaidenJobProcessType kjpType, KaidenJobIdIF kaidenJobId, ErrorMode errorMode) コンストラクタ.
AbstractExtExportJob(KaidenJobTypeIF kjpType, KaidenJobIdIF kaidenJobId, Map<String,String> surfaces) コンストラクタ.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	addAllValidate(String targetKey, List<ValidateDefsDto> validateDefsList) 実行バリデート定義リストをバリデータの実行バリデート定義リストに追加.
protected void	addValidate(String targetKey, String fieldKey, KaidenValidatorIF obj, String... args) 固有実行バリデート定義を追加.
protected void	addValidate(String targetKey, String fieldKey, String validationId, String... args) 実行バリデート定義を追加.
protected void	addValidateRule() サブクラス固有のバリデート定義追加処理.
protected void	clearValidateMap(String targetCompany) バリデート実行クラス格納Mapのクリア.
protected void	closeMain() サブクラス固有の後処理.
protected void	complementSettings() 設定の省略された項目を、ジョブスケジューラーで設定した値、またはデフォルト値に保管する.
protected void	complementSettingsSub(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ds, jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings js) デフォルト設定にジョブスケジューラー設定を補完.
protected void	complementSettingsSubCompany(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings cs, jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ds, jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings js) 会社別設定にジョブスケジューラー設定を補完.
protected void	conductorErrorJobProcess() 終了処理（エラー）.
protected void	conductorExceptionJobProcess() 終了処理（例外）.
protected void	conductorFailureCompanyLock(String companyCd, String lockKey) ロック失敗処理(会社別).
protected void	conductorFailureSingleLock(String lockKey) ロック失敗処理(単一).
protected void	conductorPostCompanyProcess(String companyCd) 後処理(会社別).
protected void	conductorPostJobProcess() 後処理.
protected void	conductorPostSingleProcess() 後処理(単一).
protected void	conductorPreCompanyProcess(String companyCd) 前処理(会社別).
protected void	conductorPreJobProcess() 前処理.
protected void	conductorPreSingleProcess() 前処理(単一).
protected void	conductorSuccessJobProcess() 終了処理（成功）.
protected void	conductorWarnJobProcess() 終了処理（警告）.
protected List<OrderDto>	convertOrderList() Export設定のソーソ順をManagerで利用するソート順DTOリストに変換します.
protected String	createUniqueKey(String key) 会社別のユニークなキーを生成します.
protected String	decodeUniqueKey(String key) 会社別ユニークキーを対象キーに戻します.
protected void	doExecuteCatch(Throwable e) ジョブの実行処理のCatch節の処理.
protected void	doExecuteFinally() ジョブの実行処理のfinally節の処理.
protected jp.co.intra_mart.foundation.job_scheduler.JobResult	errorProcess(Throwable e) 例外時処理.
jp.co.intra_mart.foundation.job_scheduler.JobResult	execute()
protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult	executeBody() ジョブの実行メイン処理(単発).
protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult	executeBodyEachCompany() ジョブの実行メイン処理(会社単位).
protected jp.co.intra_mart.foundation.job_scheduler.JobResult	exportProcess() ファイルを出力します.
protected String	formatValidateErrorMessage(KaidenValidateResult validateResult) バリデートエラーメッセージを整形して返却.
protected int	getAllWarnCnt() 総警告件数を返却.
protected String	getAnotherErrEndMessage4Log(String errorMsg) ログ用ジョブ異常終了（その他）メッセージを返却.
protected String	getAnotherErrEndMsg4JobResult(String errorMsg) ジョブスケジューラー異常（その他）終了メッセージを返却.
protected List<AbstractJobProcessConductor>	getConductor() ジョブスケジューラパラメータ(conductor)の設定内容を返却.
protected String	getEachCompanyModeStartMessage4Log() ログ用会社別処理開始時メッセージを返却.
protected String	getErrEndMsg4JobResult() ジョブスケジューラー異常終了メッセージを返却.
protected String	getErrEndMsg4Log() ログ用ジョブ異常終了メッセージを返却.
protected int	getErrorCnt() 異常データ件数を返却.
protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult	getExecuteBodyResultObject()
protected abstract <DTO extends KaidenDto> List<?>	getExportData() 会社別出力対象データListを取得します.
protected abstract JPR	getGenericJobProcessResult() 汎用処理結果出力XMLを取得.
protected String	getKaidenJobId() ジョブIDを返却.
protected String	getKaidenJobName() ジョブ名称を返却.
protected Integer	getKaidenJobTypeId() 処理種類コードを返却.
protected String	getMessage(String key, Object... args) プロパティからメッセージを返却.
protected int	getNormalCnt() 正常データ件数を返却.
protected String	getProcessTargetCompanyCd() 処理対象会社コードを返却.
protected jp.co.intra_mart.foundation.job_scheduler.JobResult	getResult() 保持するジョブ実行の処理結果を返却.
protected String	getScsEndMsg4JobResult() ジョブスケジューラー正常終了メッセージを返却.
protected String	getScsEndMsg4Log() ログ用ジョブ正常終了メッセージを返却.
protected <T> T	getSettingsParameter(T _job, T _this, T _default) 設定値の優先度による、設定値を返却します.
protected String	getStartMessage4Log() ログ用ジョブ開始時メッセージを返却.
protected String	getSurface(String key, Object... args) プロパティからラベルを返却.
protected abstract LinkedHashMap<String,Map<String,String>>	getSurfacesMap() ラベル定義を格納したMapを返却します.
protected abstract LinkedHashMap<String,List<?>>	getTargetDataListMap() 処理対象データリストをデータリストを格納したMapを取得します.
protected KaidenValidateExecutorForJob	getValidateExecuter() 対象キーに紐づくジョブスケジューラーバリデート実行クラスを取得します.
protected KaidenValidateExecutorForJob	getValidateExecuter(String targetKey) 対象キーに紐づくジョブスケジューラーバリデート実行クラスを取得します.
protected int	getWarnCnt() 警告件数を返却.
Map<String,Integer>	getWarnCountsMap() 警告件数格納Mapを返却.
protected String	getWarnEndMsg4JobResult() ジョブスケジューラー警告終了メッセージを返却.
protected String	getWarnEndMsg4Log() ログ用ジョブ警告終了メッセージを返却.
protected void	globalPost(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult _result) 後処理.
protected void	initForCompany() 会社別初期化処理.
protected void	initJobProcessResult() 処理結果の初期化.
protected void	initMain() 初期化処理.
protected boolean	isIncossisteneData() 不整合データ出力有無を返却します.
protected boolean	isUseCacheOnXmlRead() XMLセッテイングのキャッシュ利用有無.
protected boolean	isValidate() バリデート処理.
protected jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings	makeJobSchedulerSettings() ジョブスケジューラ側から設定されたパラメータを取得し、設定クラスを作成.
protected void	outputJobProcessResult() 処理結果XMLを出力します.
protected void	outsetMain() サブクラス固有の前処理.
protected void	outsetMainForExport(SETTINGS settings) Export固有の前処理を行います.
protected boolean	postValidate(List<KaidenValidateResult> validateResultList) バリデート後固有処理.
protected void	preValidate() バリデート前固有処理.
protected jp.co.intra_mart.foundation.job_scheduler.JobResult	processMain() サブクラス固有の本処理.
protected SETTINGS	read(Class<SETTINGS> clazz) xsdによるスキーマ検証を行わずに、Export設定を読み込んで返却します.
protected abstract SETTINGS	readSettingsForExport() 設定ファイル読込.
protected void	registHistoryToResult() ジョブの実行履歴と処理結果XMLファイルを紐づけるトランデータを登録します.
protected void	removeValidateDef(String targetKey, String fieldKey, Class<? extends KaidenValidatorIF> clazz) バリデータの実行バリデート定義を削除.
protected void	setExecuteBodyResultError(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult, boolean _isError) 実行メイン処理結果エラー有無を設定.
protected void	setExecuteBodyResultException(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult, Throwable e) 実行メイン処理結果発生Exceptionを設定.
protected void	setExecuteBodyResultWarning(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult, boolean _isWarning) 実行メイン処理結果警告有無を設定.
protected void	setIgnoreValidate(Class<? extends KaidenValidatorIF> clazz) バリデート実行結果異常を無視するバリデートクラスを追加.
protected void	setJobSchedulerParameter() ジョブスケジューラ側から設定されたパラメータを取得し、設定値とする.
protected void	setProcessTargetCompanyCd(String companyCd) 処理対象会社コードを設定.
protected void	setResult(jp.co.intra_mart.foundation.job_scheduler.JobResult _result) ジョブ実行の処理結果を設定.
protected void	setResult(jp.co.intra_mart.foundation.job_scheduler.JobResult _result, boolean forceFlag) ジョブ実行の処理結果を設定.
protected void	setSettingsForExport() パラメータ設定.
protected void	validateSettings(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ss, boolean isJobSettings) パラメータ情報の整合性チェック.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

extExportHelper

protected ExtExportHelper extExportHelper

ExtExportHelper.

exportSettings

protected SETTINGS extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF<?,?> exportSettings

export設定.

normalCount

protected int normalCount

正常データ件数.

errorCount

protected int errorCount

異常データ件数.

validateMap

protected Map<String,KaidenValidateExecutorForJob> validateMap

バリデート実行クラス格納Map.

errorMode

protected ErrorMode errorMode

エラー時処理続行制御.

companyList

protected List<String> companyList

会社コードリスト.

processTargetCompanyCd

protected String processTargetCompanyCd

処理対象会社コード.

processingCompanyCd

protected String processingCompanyCd

処理中会社コード.

contextHelper

protected ContextHelper contextHelper

ContextHelper.

jobProcessResult

protected JPR extends jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_jop_process_result.GenericJobProcessResult jobProcessResult

汎用処理結果出力XML.

dateHelper

protected DateHelper dateHelper

DateHelper.

companyManagerHelper

protected CompanyManagerHelper companyManagerHelper

CompanyManagerHelper.

propertyHelper

protected PropertyHelper propertyHelper

PropertyHelper.

systemLocaleHelper

protected SystemLocaleHelper systemLocaleHelper

SystemLocaleHelper.

xmlOutputHelper

protected XmlOutputHelper xmlOutputHelper

XmlOutputHelper.

lockHelper

protected LockHelper lockHelper

LockHelper.

transactionHelper

protected TransactionHelper transactionHelper

TransactionHelper.

eachCompanyModeFlag

protected boolean eachCompanyModeFlag

会社単位処理モードフラグ.

 会社単位で処理を実行するかを設定します。
 デフォルトはTrue(会社単位で実行)になっています。
 必要に応じてサブクラスで上書いてください。
 

コンストラクタの詳細

AbstractExtExportJob

public AbstractExtExportJob(KaidenJobTypeIF kjpType,
                            KaidenJobIdIF kaidenJobId,
                            Map<String,String> surfaces)

コンストラクタ.

パラメータ:

kjpType - 皆伝ジョブ処理タイプ

kaidenJobId - 皆伝ジョブID

surfaces - ラベル定義

AbstractExtExportJob

public AbstractExtExportJob(KaidenJobProcessType kjpType,
                            KaidenJobIdIF kaidenJobId,
                            ErrorMode errorMode)

コンストラクタ.

 バリデートでエラーが発生した際に、後続処理を行いたくない場合、引数[JoberrorMode]にErrorMode.ERROR_ENDを設定して利用。
 

パラメータ:

kjpType - 皆伝ジョブ処理タイプ

kaidenJobId - 皆伝ジョブID

errorMode - エラー時処理続行制御

メソッドの詳細

initMain

protected void initMain()

初期化処理.

 サブクラスで一番最初に実行される処理です。
 主に設定の読み込み、バリデート定義の追加などの実装を想定しています。
 

getTargetDataListMap

protected abstract LinkedHashMap<String,List<?>> getTargetDataListMap()

処理対象データリストをデータリストを格納したMapを取得します.

戻り値:

処理対象データリスト

readSettingsForExport

protected abstract SETTINGS readSettingsForExport()

設定ファイル読込.

戻り値:

export設定

read

protected SETTINGS read(Class<SETTINGS> clazz)

xsdによるスキーマ検証を行わずに、Export設定を読み込んで返却します.

パラメータ:

clazz - Export設定対象クラス

戻り値:

Export設定

setSettingsForExport

protected void setSettingsForExport()

パラメータ設定.

setJobSchedulerParameter

protected void setJobSchedulerParameter()

ジョブスケジューラ側から設定されたパラメータを取得し、設定値とする.

makeJobSchedulerSettings

protected jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings makeJobSchedulerSettings()

ジョブスケジューラ側から設定されたパラメータを取得し、設定クラスを作成.

戻り値:

ジョブスケジューラ設定

complementSettings

protected void complementSettings()

設定の省略された項目を、ジョブスケジューラーで設定した値、またはデフォルト値に保管する.

 ジョブスケジューラーから値が設定されている場合は、最優先します。
 

complementSettingsSub

protected void complementSettingsSub(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ds,
                                     jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings js)

デフォルト設定にジョブスケジューラー設定を補完.

 基底では何も処理を行いません。
 サブクラスで拡張した情報を補完するために用意しています。
 

パラメータ:

ds - デフォルト設定

js - ジョブスケジューラー設定

complementSettingsSubCompany

protected void complementSettingsSubCompany(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings cs,
                                            jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ds,
                                            jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings js)

会社別設定にジョブスケジューラー設定を補完.

 基底では何も処理を行いません。
 サブクラスで拡張した情報を補完するために用意しています。
 

パラメータ:

cs - 会社別設定

ds - デフォルト設定

js - ジョブスケジューラー設定

validateSettings

protected void validateSettings(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.generic_ext_export_settings.GenericExportSettingsIF.Settings ss,
                                boolean isJobSettings)

パラメータ情報の整合性チェック.

パラメータ:

ss - パラメータ情報

isJobSettings - ジョブスケジューラパラメータかどうか

isIncossisteneData

protected boolean isIncossisteneData()

不整合データ出力有無を返却します.

戻り値:

true:出力する, false:出力しない

outsetMain

protected void outsetMain()
                   throws KaidenSystemException

サブクラス固有の前処理.

 AbstractJob.outset()の最後に実行される処理です。 
 主な処理として、importでは対象ファイルの読み込み、exportでは出力対象データの取得などの実装を想定しています。
 

例外:

KaidenSystemException - システムエラー

outsetMainForExport

protected void outsetMainForExport(SETTINGS settings)

Export固有の前処理を行います.

 処理を追加したい場合のみ、Overrideして実装してください。
 

パラメータ:

settings - Export設定

convertOrderList

protected List<OrderDto> convertOrderList()

Export設定のソーソ順をManagerで利用するソート順DTOリストに変換します.

戻り値:

ソート順DTOリスト

processMain

protected jp.co.intra_mart.foundation.job_scheduler.JobResult processMain()
                                                                   throws KaidenSystemException

サブクラス固有の本処理.

 AbstractJob#process(String)内で最後に実行される処理です。
 

戻り値:

ジョブ実行処理結果

例外:

KaidenSystemException - システムエラー

doExecuteCatch

protected void doExecuteCatch(Throwable e)

ジョブの実行処理のCatch節の処理.

 AbstractJob.execute()のCatch節で実行する処理です。
 

 退避したファイルを戻します。
 

パラメータ:

e - 例外

doExecuteFinally

protected void doExecuteFinally()

ジョブの実行処理のfinally節の処理.

 AbstractJob.execute()のfinally節で実行する処理です。
 

 退避したファイルがあれば削除します。
 

exportProcess

protected jp.co.intra_mart.foundation.job_scheduler.JobResult exportProcess()
                                                                     throws KaidenSystemException

ファイルを出力します.

戻り値:

ジョブ実行処理結果

例外:

KaidenSystemException - システムエラー

getExportData

protected abstract <DTO extends KaidenDto> List<?> getExportData()

会社別出力対象データListを取得します.

型パラメータ:

DTO - 処理対象DTOの型

戻り値:

会社別出力対象データList

getErrEndMsg4Log

protected String getErrEndMsg4Log()

ログ用ジョブ異常終了メッセージを返却.

 message:{0}の{1}処理を終了しました。（結果：バリデーションエラー、処理件数{2}件、エラー件数{3}件）
 

戻り値:

ログ用ジョブ異常終了メッセージ

isUseCacheOnXmlRead

protected boolean isUseCacheOnXmlRead()

XMLセッテイングのキャッシュ利用有無.

戻り値:

false：利用しない

getNormalCnt

protected int getNormalCnt()

正常データ件数を返却.

 normalCountを返却します。
 サブクラスでnormalCountを適宜変更してください。
 

戻り値:

正常データ件数

getErrorCnt

protected int getErrorCnt()

異常データ件数を返却.

 errorCountを返却します。
 サブクラスでerrorCountを適宜変更してください。
 

戻り値:

異常データ件数

getGenericJobProcessResult

protected abstract JPR getGenericJobProcessResult()

汎用処理結果出力XMLを取得.

戻り値:

汎用処理結果出力XML

initJobProcessResult

protected void initJobProcessResult()

処理結果の初期化.

execute

public jp.co.intra_mart.foundation.job_scheduler.JobResult execute()
                                                            throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

定義:

execute インタフェース内 jp.co.intra_mart.foundation.job_scheduler.Job

例外:

jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

initForCompany

protected void initForCompany()

会社別初期化処理.

会社別の初期化処理の実装を想定しています。

executeBodyEachCompany

protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult executeBodyEachCompany()
                                                                                                 throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

ジョブの実行メイン処理(会社単位).

 @ link #eachCompanyModeFlagメソッド内で、eachCompanyModeFlag がTrueの場合に実行されるメイン処理です。 
 対象会社リストの件数分繰り返して処理を行います。
 

戻り値:

実行メイン処理結果

例外:

jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException - ジョブ実行中に例外が発生

executeBody

protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult executeBody()
                                                                                      throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

ジョブの実行メイン処理(単発).

 @ link #eachCompanyModeFlagメソッド内で、eachCompanyModeFlag が #eachCompanyModeFlag}
 がFalseの場合に実行されるメイン処理です。
 一度だけ処理を行います。
 

戻り値:

実行メイン処理結果

例外:

jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException - ジョブ実行中に例外が発生

errorProcess

protected jp.co.intra_mart.foundation.job_scheduler.JobResult errorProcess(Throwable e)
                                                                    throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

例外時処理.

パラメータ:

e - 例外オブジェクト

戻り値:

ジョブ実行結果

例外:

jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException - ジョブ実行結果例外

getSettingsParameter

protected <T> T getSettingsParameter(T _job,
                                     T _this,
                                     T _default)

設定値の優先度による、設定値を返却します.

 以下、優先順位と取得元
 1.ジョブスケジューラから設定された値
 2.会社別の設定値
 3.デフォルト値
 

型パラメータ:

T - 設定値の型

パラメータ:

_job - ジョブスケジューラから設定された値

_this - 会社別の設定値

_default - デフォルト値

戻り値:

設定値

getSurfacesMap

protected abstract LinkedHashMap<String,Map<String,String>> getSurfacesMap()

ラベル定義を格納したMapを返却します.

戻り値:

ラベル定義

addValidateRule

protected void addValidateRule()
                        throws KaidenSystemException

サブクラス固有のバリデート定義追加処理.

 サブクラス固有のバリデートを行いたい場合に、定義の追加処理を実装してください。
 

例外:

KaidenSystemException - システムエラー

preValidate

protected void preValidate()

バリデート前固有処理.

 AbstractJob.outset()の最初に実行される処理です。 
 処理を追加したい場合のみ、Overrideして実装してください。
 

isValidate

protected boolean isValidate()
                      throws KaidenSystemException

バリデート処理.

 AbstractJob#process(String)で最初に実行されるバリデート処理です。
 本処理はバリデート定義が存在しない場合、固定で異常なし(false)を返却します。
 バリデート結果は異常なしでも、バリデート実行結果Listの空インスタンスが返却されます。
 処理の変更が必要な場合のみ、Overrideして実装してください。
 バリデート処理前の固有処理を行いたい場合、AbstractJob.preValidate()をOverrideして実装してください。
 バリデート処理後の固有処理を変更したい場合、AbstractJob#postValidate()をOverrideして実装してください。
 

戻り値:

バリデート結果 true:異常あり、false:異常なし

例外:

KaidenSystemException - システムエラー

addValidate

protected void addValidate(String targetKey,
                           String fieldKey,
                           String validationId,
                           String... args)

実行バリデート定義を追加.

 ラベル定義MAPのキーはフィールドキーを利用します。
 

パラメータ:

targetKey - バリデート対象データリストキー

fieldKey - バリデート対象フィールドキー

validationId - 実行バリデートID

args - バリデート実行時パラメータ

addValidate

protected void addValidate(String targetKey,
                           String fieldKey,
                           KaidenValidatorIF obj,
                           String... args)

固有実行バリデート定義を追加.

 ラベル定義MAPのキーはフィールドキーを利用します。
 

パラメータ:

targetKey - バリデート対象キー

fieldKey - バリデート対象フィールドキー

obj - バリデータインスタンス

args - バリデート実行時パラメータ

addAllValidate

protected void addAllValidate(String targetKey,
                              List<ValidateDefsDto> validateDefsList)

実行バリデート定義リストをバリデータの実行バリデート定義リストに追加.

パラメータ:

targetKey - バリデート対象キー

validateDefsList - 実行バリデート定義リスト

removeValidateDef

protected void removeValidateDef(String targetKey,
                                 String fieldKey,
                                 Class<? extends KaidenValidatorIF> clazz)

バリデータの実行バリデート定義を削除.

パラメータ:

targetKey - バリデート対象キー

fieldKey - バリデート対象フィールドキー

clazz - 削除対象バリデート

setIgnoreValidate

protected void setIgnoreValidate(Class<? extends KaidenValidatorIF> clazz)

バリデート実行結果異常を無視するバリデートクラスを追加.

パラメータ:

clazz - 無視対象バリデータのクラス

postValidate

protected boolean postValidate(List<KaidenValidateResult> validateResultList)

バリデート後固有処理.

 AbstractJob.isValidate()内で最後に実行される処理です。 
 処理の変更が必要な場合のみ、Overrideして実装してください。
 

パラメータ:

validateResultList - バリデート実行結果List

戻り値:

バリデート結果 true:異常あり、false:異常なし

formatValidateErrorMessage

protected String formatValidateErrorMessage(KaidenValidateResult validateResult)

バリデートエラーメッセージを整形して返却.

 ログ(XML)出力用にバリデートエラーメッセージを整えて返却します。
 標準ではメインメッセージをそのまま返却します。
 

パラメータ:

validateResult - バリデート結果

戻り値:

成形後メッセージ

outputJobProcessResult

protected void outputJobProcessResult()

処理結果XMLを出力します.

registHistoryToResult

protected void registHistoryToResult()
                              throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException

ジョブの実行履歴と処理結果XMLファイルを紐づけるトランデータを登録します.

例外:

jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException - ジョブ実行中に例外が発生

closeMain

protected void closeMain()
                  throws KaidenSystemException

サブクラス固有の後処理.

 一番最後に実行される処理です。
 

例外:

KaidenSystemException - システムエラー

getProcessTargetCompanyCd

protected String getProcessTargetCompanyCd()

処理対象会社コードを返却.

戻り値:

companyCd 会社コード

setProcessTargetCompanyCd

protected void setProcessTargetCompanyCd(String companyCd)

処理対象会社コードを設定.

パラメータ:

companyCd - 処理対象会社コード

setResult

protected void setResult(jp.co.intra_mart.foundation.job_scheduler.JobResult _result)

ジョブ実行の処理結果を設定.

パラメータ:

_result - ジョブ実行の処理結果

setResult

protected void setResult(jp.co.intra_mart.foundation.job_scheduler.JobResult _result,
                         boolean forceFlag)

ジョブ実行の処理結果を設定.

 forceFlagがTrueの場合はresultを引数の_resultで上書きます。
 forceFlagがFalseの場合は更新前のステータスと引数の_resultのステータスにより上書くか判定します。
 

更新前ステータス	引数のステータス	更新有無
SUCCESS	SUCCESS	する
	WARNING	する
	ERROR	する
WARNING	SUCCESS	しない
	WARNING	しない
	ERROR	する
ERROR	SUCCESS	しない
	WARNING	しない
	ERROR	しない

パラメータ:

_result - ジョブ実行の処理結果

forceFlag - ジョブ実行の処理結果(強制上書き)

getResult

protected jp.co.intra_mart.foundation.job_scheduler.JobResult getResult()

保持するジョブ実行の処理結果を返却.

戻り値:

イベントの結果

getStartMessage4Log

protected String getStartMessage4Log()

ログ用ジョブ開始時メッセージを返却.

 message:{0}を開始しました。
 

戻り値:

ログ用ジョブ開始時メッセージメッセージ

getEachCompanyModeStartMessage4Log

protected String getEachCompanyModeStartMessage4Log()

ログ用会社別処理開始時メッセージを返却.

 message:会社別処理[{0}]を開始しました。
 

戻り値:

ログ用会社別処理開始時メッセージ

getScsEndMsg4Log

protected String getScsEndMsg4Log()

ログ用ジョブ正常終了メッセージを返却.

 message:{0}の{1}が正常に終了しました。（処理件数{2}件）.
 

戻り値:

ログ用ジョブ正常終了メッセージ

getWarnEndMsg4Log

protected String getWarnEndMsg4Log()

ログ用ジョブ警告終了メッセージを返却.

 message:{0}の{1}処理を終了しました。（結果：バリデーションエラー、処理件数{2}件、エラー件数{3}件）
 

戻り値:

ログ用ジョブ警告終了メッセージ

getAnotherErrEndMessage4Log

protected String getAnotherErrEndMessage4Log(String errorMsg)

ログ用ジョブ異常終了（その他）メッセージを返却.

 message:{0}の{1}処理を終了しました。（結果：エラー、{2}）
 

パラメータ:

errorMsg - エラーメッセージ

戻り値:

ログ用ジョブ異常終了（その他）メッセージ

getScsEndMsg4JobResult

protected String getScsEndMsg4JobResult()

ジョブスケジューラー正常終了メッセージを返却.

 message:{0}の{1}が正常に終了しました。（処理件数{2}件）
 

戻り値:

ジョブスケジューラー正常終了メッセージ

getWarnEndMsg4JobResult

protected String getWarnEndMsg4JobResult()

ジョブスケジューラー警告終了メッセージを返却.

 message:{0}の{1}処理を終了しました。（結果：バリデーションエラー、処理件数{2}件、エラー件数{3}件）
 

戻り値:

ジョブスケジューラー警告終了メッセージ

getErrEndMsg4JobResult

protected String getErrEndMsg4JobResult()

ジョブスケジューラー異常終了メッセージを返却.

 message:{0}の{1}処理を終了しました。（結果：バリデーションエラー、処理件数{2}件、エラー件数{3}件）
 

戻り値:

ジョブスケジューラー異常終了メッセージ

getAnotherErrEndMsg4JobResult

protected String getAnotherErrEndMsg4JobResult(String errorMsg)

ジョブスケジューラー異常（その他）終了メッセージを返却.

 message:{0}を終了しました。（結果：エラー、{1}）
 

パラメータ:

errorMsg - エラーメッセージ

戻り値:

ジョブスケジューラー異常（その他）終了メッセージ

getMessage

protected String getMessage(String key,
                            Object... args)

プロパティからメッセージを返却.

 ロケールはシステムデフォルトロケールを利用します。任意のローケールを指定することはできません。
 

パラメータ:

key - キー

args - 置換文字列の配列

戻り値:

置換文字列を挿入したメッセージ

getSurface

protected String getSurface(String key,
                            Object... args)

プロパティからラベルを返却.

 ロケールはシステムデフォルトロケールを利用します。任意のローケールを指定することはできません。
 

パラメータ:

key - キー

args - 置換文字列の配列

戻り値:

置換文字列を挿入したメッセージ

getWarnCnt

protected int getWarnCnt()

警告件数を返却.

戻り値:

警告件数

getAllWarnCnt

protected int getAllWarnCnt()

総警告件数を返却.

戻り値:

総警告件数

getValidateExecuter

protected KaidenValidateExecutorForJob getValidateExecuter()

対象キーに紐づくジョブスケジューラーバリデート実行クラスを取得します.

戻り値:

ジョブスケジューラーバリデート実行クラス

getValidateExecuter

protected KaidenValidateExecutorForJob getValidateExecuter(String targetKey)

対象キーに紐づくジョブスケジューラーバリデート実行クラスを取得します.

パラメータ:

targetKey - 対象キー

戻り値:

ジョブスケジューラーバリデート実行クラス

createUniqueKey

protected String createUniqueKey(String key)

会社別のユニークなキーを生成します.

パラメータ:

key - 対象キー

戻り値:

会社別ユニークキー

decodeUniqueKey

protected String decodeUniqueKey(String key)

会社別ユニークキーを対象キーに戻します.

パラメータ:

key - 会社別ユニークキー

戻り値:

対象キー

clearValidateMap

protected void clearValidateMap(String targetCompany)

バリデート実行クラス格納Mapのクリア.

 バリデート実行クラス格納Map中の指定された会社コードをキーに含むエントリを削除します。
 

パラメータ:

targetCompany - 対象会社コード

getKaidenJobId

protected String getKaidenJobId()

ジョブIDを返却.

戻り値:

ジョブID

getKaidenJobName

protected String getKaidenJobName()

ジョブ名称を返却.

戻り値:

ジョブ名称

getKaidenJobTypeId

protected Integer getKaidenJobTypeId()

処理種類コードを返却.

戻り値:

処理種類名称

getWarnCountsMap

public Map<String,Integer> getWarnCountsMap()

警告件数格納Mapを返却.

戻り値:

警告件数格納Map.

globalPost

protected void globalPost(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult _result)

後処理.

 会社別処理がすべて終了した後に実行される後処理です。
 

パラメータ:

_result - メイン処理処理結果

getConductor

protected List<AbstractJobProcessConductor> getConductor()

ジョブスケジューラパラメータ(conductor)の設定内容を返却.

戻り値:

AbstractJobProcessConductorを継承したコンダクターリスト

conductorPreJobProcess

protected void conductorPreJobProcess()

前処理.

conductorPostJobProcess

protected void conductorPostJobProcess()

後処理.

conductorErrorJobProcess

protected void conductorErrorJobProcess()

終了処理（エラー）.

conductorWarnJobProcess

protected void conductorWarnJobProcess()

終了処理（警告）.

conductorSuccessJobProcess

protected void conductorSuccessJobProcess()

終了処理（成功）.

conductorExceptionJobProcess

protected void conductorExceptionJobProcess()

終了処理（例外）.

conductorPreCompanyProcess

protected void conductorPreCompanyProcess(String companyCd)

前処理(会社別).

パラメータ:

companyCd - 会社コード

conductorPostCompanyProcess

protected void conductorPostCompanyProcess(String companyCd)

後処理(会社別).

パラメータ:

companyCd - 会社コード

conductorFailureCompanyLock

protected void conductorFailureCompanyLock(String companyCd,
                                           String lockKey)

ロック失敗処理(会社別).

パラメータ:

companyCd - 会社コード

lockKey - ロックキー

conductorPreSingleProcess

protected void conductorPreSingleProcess()

前処理(単一).

conductorPostSingleProcess

protected void conductorPostSingleProcess()

後処理(単一).

conductorFailureSingleLock

protected void conductorFailureSingleLock(String lockKey)

ロック失敗処理(単一).

パラメータ:

lockKey - ロックキー

getExecuteBodyResultObject

protected jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult getExecuteBodyResultObject()

setExecuteBodyResultError

protected void setExecuteBodyResultError(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult,
                                         boolean _isError)

実行メイン処理結果エラー有無を設定.

パラメータ:

bodyResult - 実行メイン処理結果

_isError - エラー有無

setExecuteBodyResultWarning

protected void setExecuteBodyResultWarning(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult,
                                           boolean _isWarning)

実行メイン処理結果警告有無を設定.

パラメータ:

bodyResult - 実行メイン処理結果

_isWarning - 警告有無

setExecuteBodyResultException

protected void setExecuteBodyResultException(jp.co.slcs.kaiden.v2.base.foundation.job.AbstractJob.ExecuteBodyResult bodyResult,
                                             Throwable e)

実行メイン処理結果発生Exceptionを設定.

パラメータ:

bodyResult - 実行メイン処理結果

e - 発生Exception