net.createform.ro

クラス JobDescriptor

java.lang.Object

net.createform.ro.JobDescriptor

public class JobDescriptor
extends java.lang.Object

ジョブの ID やプロパティを保持するデータオブジェクトです。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.String	getId() ジョブ ID を返します。
java.lang.String	getProperty(java.lang.String key) プロパティを返します。
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) プロパティを返します。
java.util.Date	getPropertyAsDate(java.lang.String key) プロパティを Date オブジェクトとして返します。
java.util.Date	getPropertyAsDate(java.lang.String key, java.util.Date defaultValue) プロパティを Date オブジェクトとして返します。
int	getPropertyAsInt(java.lang.String key) プロパティを int として返します。
int	getPropertyAsInt(java.lang.String key, int defaultValue) プロパティを int として返します。
int	getTimes() ジョブが実行された回数を返します。
int	getTimes(CreateFormMode mode) mode で指定された実行モードのジョブが実行された回数を返します。
void	removeProperty(java.lang.String key) 指定されたプロパティを削除します。
void	setProperty(java.lang.String key, java.lang.String value) プロパティを登録します。

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

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

メソッドの詳細

getId

public java.lang.String getId()

ジョブ ID を返します。

戻り値:

ジョブ ID

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

プロパティを登録します。

パラメータ:

key - プロパティのキー

value - プロパティの値

getProperty

public java.lang.String getProperty(java.lang.String key)

プロパティを返します。 指定されたキーに該当するプロパティが存在しない場合は null を返します。

パラメータ:

key - プロパティのキー

戻り値:

プロパティの値

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

プロパティを返します。 指定されたキーに該当するプロパティが存在しない場合は defaultValue を返します。

パラメータ:

key - プロパティのキー

defaultValue - キーが存在しない場合に返す値

戻り値:

プロパティの値

getPropertyAsInt

public int getPropertyAsInt(java.lang.String key)

プロパティを int として返します。 指定されたキーに該当するプロパティが存在しない場合や int 値として妥当ではない値の場合は 0 を返します。

パラメータ:

key - プロパティのキー

戻り値:

プロパティの値

getPropertyAsInt

public int getPropertyAsInt(java.lang.String key,
                            int defaultValue)

プロパティを int として返します。 指定されたキーに該当するプロパティが存在しない場合や int 値として妥当ではない値の場合は defaultValue を返します。

パラメータ:

key - プロパティのキー

defaultValue - キーが存在しない場合に返す値

戻り値:

プロパティの値

getPropertyAsDate

public java.util.Date getPropertyAsDate(java.lang.String key)

プロパティを Date オブジェクトとして返します。 指定されたキーに該当するプロパティが存在しない場合や Date 型として妥当ではない値の場合は null を返します。

パラメータ:

key - プロパティのキー

戻り値:

プロパティの値

getPropertyAsDate

public java.util.Date getPropertyAsDate(java.lang.String key,
                                        java.util.Date defaultValue)

プロパティを Date オブジェクトとして返します。 指定されたキーに該当するプロパティが存在しない場合や Date 型として妥当ではない値の場合は defaultValue を返します。

パラメータ:

key - プロパティのキー

defaultValue - キーが存在しない場合に返す値

戻り値:

プロパティの値

removeProperty

public void removeProperty(java.lang.String key)

指定されたプロパティを削除します。

パラメータ:

key - 削除するプロパティのキー

getTimes

public int getTimes()

ジョブが実行された回数を返します。

戻り値:

実行回数

getTimes

public int getTimes(CreateFormMode mode)

mode で指定された実行モードのジョブが実行された回数を返します。

パラメータ:

mode - 実行モード

戻り値:

実行回数