3.7.2 LogicalDestinationクラス

定数	説明
DOCUMENT_PUSH	論理あて先タイプは、帳票配信用です。
LOCAL_PRINT	論理あて先タイプは、Web手元印刷用です。

定数	説明
STATUS_ERROR	出力エラー状態は、エラーです。
STATUS_NORMAL	出力エラー状態は、通常（エラーなし）です。
STATUS_WAIT_REPLY	出力エラー状態は、応答待ちです。

定数	説明
OUTPUT_MODE_OUTPUT	帳票作成後の出力指定は、「出力する」です。
OUTPUT_MODE_NONE	帳票作成後の出力指定は、「出力しない（帳票の登録のみ行う）」です。
OUTPUT_MODE_USE_FORM_ATTRIBUTE	帳票作成後の出力指定は、「帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票属性にしたがう」です。

定数	説明
KEEP_MODE_KEEP	帳票出力後の保存指定は、「保存する」です。
KEEP_MODE_NONE	帳票出力後の保存指定は、「保存しない」です。
KEEP_MODE_USE_FORM_ATTRIBUTE	帳票出力後の保存指定は、「帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票属性にしたがう」です。

定数	説明
KEEP_DAYS_NO_LIMIT	保存日数の指定は、無期限です。
KEEP_DAYS_USE_FORM_ATTRIBUTE	保存日数の指定は、「帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票属性にしたがう」です。

public java.lang.String

getName()

用途

論理あて先名を取得します。

戻り値

論理あて先名

public java.lang.String

getComment()

用途

論理あて先のコメントを取得します。

戻り値

なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public int

getType()

用途

論理あて先の論理あて先タイプを取得します。

戻り値

論理あて先タイプを示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetTypeメソッドで取得されるフィールド”

public int

getPriority()

用途

論理あて先の優先度を取得します。

論理あて先タイプが「DOCUMENT_PUSH」の場合に、有効な値を取得できます。

戻り値

優先度を示す数値1（優先度：低）～10（優先度：高）

public java.lang.String

getDeviceName()

用途

論理あて先に対応付けされている論理デバイス名を取得します。

戻り値

論理デバイス名

public java.lang.String

getDeviceComment()

用途

論理あて先に対応付けされている論理デバイスのコメント（出力先）を取得します。

戻り値

コメント（出力先）

なお、コメント（出力先）が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public int

getOutputMethod()

用途

論理あて先に対応付けされている論理デバイスの出力方法を取得します。

戻り値

出力方法を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”

public boolean

isActive()

用途

論理あて先の状態を取得します。

論理あて先タイプが「DOCUMENT_PUSH」の場合にのみ、有効な値を取得できます。

戻り値

true：: 論理あて先が「起動中」の場合

false：: 論理あて先が「停止中」の場合

public int

getOutputMode()

用途

帳票作成後の出力指定を取得します。

帳票作成後の出力指定は、帳票作成後に続けて出力を行うかどうかの指定です。

戻り値

帳票作成後の出力指定を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetOutputModeメソッドで取得されるフィールド”

public int

getKeepMode()

用途

帳票出力後の保存指定を取得します。

帳票出力後の保存指定は、帳票出力後、List Managerに帳票を保存するかどうかの指定です。

戻り値

帳票出力後の保存指定を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetKeepModeメソッドで取得されるフィールド”

public int

getKeepDays()

用途

論理あて先内の帳票の保存日数の指定を取得します。

戻り値

以下のいずれかが取得されます。

List Managerで帳票を保存する日数（1～9999）
帳票の保存日数の指定を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetKeepDaysメソッドで取得されるフィールド”

public java.lang.String

getCustomizeItem1()

用途

論理あて先のカスタマイズ項目1を取得します。

戻り値

カスタマイズ項目1

なお、カスタマイズ項目1が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getCustomizeItem2()

用途

論理あて先のカスタマイズ項目2を取得します。

戻り値

カスタマイズ項目2

なお、カスタマイズ項目2が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getCustomizeItem3()

用途

論理あて先のカスタマイズ項目3を取得します。

戻り値

カスタマイズ項目3

なお、カスタマイズ項目3が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getCustomizeItem4()

用途

論理あて先のカスタマイズ項目4を取得します。

戻り値

カスタマイズ項目4

なお、カスタマイズ項目4が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getCustomizeItem5()

用途

論理あて先のカスタマイズ項目5を取得します。

戻り値

カスタマイズ項目5

なお、カスタマイズ項目5が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public int

getErrorStatus()

用途

論理あて先の出力エラー状態を取得します。

戻り値

出力エラー状態を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“LogicalDestination クラスのgetErrorStatus メソッドで取得されるフィールド”

public void

start()

throws OperateException,java.lang.IllegalStateException

用途

論理あて先を起動します。

戻り値

OperateException：: 起動処理でエラーが発生した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先を起動するには、論理あて先に対する表示権限および管理権限が必要です。

public void

stop()

throws OperateException,java.lang.IllegalStateException

用途

論理あて先を停止します。

戻り値

OperateException：: 停止処理でエラーが発生した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先を停止するには、論理あて先に対する表示権限および管理権限が必要です。

public void

changeDevice(LogicalDevice device)

throws OperateException, java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

論理あて先に対応付けされている出力先（論理デバイス）を切り替えます。

論理あて先の出力先として切り替えできる論理あて先の論理あて先タイプと、論理デバイスの出力方法の関係を、以下の表に示します。

出力先を切り替える論理あて先の論理あて先タイプ	切り替え先として指定できる論理デバイスの出力方法
帳票配信用	帳票配信型の場合のプリンタ（印刷）
	帳票配信型の場合のList Works（電子保存(Interstage List Manager互換のための機能)）
	帳票配信型の場合のPDF（PDFファイル保存）
Web手元印刷用	Web手元印刷型の場合のPDF（PDFファイル）
Web手元印刷用	Web手元印刷型の場合のOWF（OWFファイル）

パラメータ

device：: 切り替え先の出力先（論理デバイス）を指定します。

例外

OperateException：

出力先を切り替える論理あて先が存在しなかった場合
切り替え処理でエラーが発生した場合
List Managerが開始されていない状態の場合
切り替えを行う論理あて先に、以下の出力状態の帳票が存在した場合
- 出力エラー
- 応答待ち
- 出力中
- 出力待ち
- 出力保留
- 配信中
- 配信待ち

java.lang.Illegal ArgumentException：: deviceパラメータに「null」を指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先に対応付けされている出力先（論理デバイス）を切り替えるには、論理あて先に対する表示権限および管理権限が必要です。

備考

論理あて先を停止した状態で、論理あて先の出力先（論理デバイス）を切り替えることを推奨します。

public Form

getForm(java.lang.String formID)

throws OperateException, java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票IDを指定して、論理あて先内の帳票を取得します。

パラメータ

formID：

取得する帳票の帳票IDを指定します。

帳票IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することはできません。

戻り値

帳票

なお、該当する帳票がない場合は、「null」が取得されます。

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定した帳票IDが「null」の場合
指定した帳票IDに「クエスチョンマーク（?）」または「アスタリスク（*）」が含まれている場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索した論理あて先名）が更新されます。

public Form[]

getForms(SortOrder[] sortOrder)

throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

論理あて先内の帳票を取得します。

パラメータ

sortOrder：

取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。

ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2番目に指定したソート項目でソートが行われます。

「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。

ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”

戻り値

帳票の配列

なお、論理あて先内に帳票がない場合は、長さ0の配列が取得されます。

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索した論理あて先名）が更新されます。

public ListResult

getForms(SortOrder[] sortOrder,int resultLimit)

throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

最大取得件数を指定して、論理あて先内の帳票を取得します。

最大取得件数は、取得する帳票の最大数です。

帳票を取得した結果は、ListResultクラスのgetListメソッドの戻り値をForm[]にキャストして取得します。

パラメータ

sortOrder：

取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。

「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。

ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”

resultLimit：

帳票の最大取得件数を指定します。

「0」以下の値を指定した場合は無制限になります。

戻り値

一覧で取得した結果

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6 個以上指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索した論理あて先名）が更新されます。

public Form[]

getForms(FormFilterCondition condition,SortOrder[] sortOrder)

throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票の絞り込み条件を指定して、論理あて先内の帳票を取得します。

パラメータ

condition：

帳票を絞り込んで検索するときの条件を指定します。

帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”

この条件で絞り込みを行わない場合は、「null」を指定します。

sortOrder：

取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。

「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。

ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”

戻り値

条件に一致した帳票の配列

なお、論理あて先内に帳票がない場合、または条件に一致する帳票がない場合は、長さ0の配列が取得されます。

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。

⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索した論理あて先名）が更新されます。

public ListResult

getForms(FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit)

throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票の絞り込み条件、および最大取得件数を指定して、論理あて先内の帳票を取得します。

最大取得件数は、取得する帳票の最大数です。

帳票を取得した結果は、ListResultクラスのgetListメソッドの戻り値をForm[]にキャストして取得します。

パラメータ

condition：

帳票の絞り込み条件を指定します。

帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”

この条件で絞り込みを行わない場合は、「null」を指定します。

sortOrder：

取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。

「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。

ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”

resultLimit：

帳票の最大取得件数を指定します。

「0」以下の値を指定した場合は無制限になります。

戻り値

一覧で取得した結果

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6 個以上指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索した論理あて先名）が更新されます。

public ListResult

getForms(FormFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)

throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、論理あて先内の帳票を取得します。

最大取得件数は取得する帳票の最大数です。

帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャスト

して取得します。

パラメータ

condition：

帳票の絞り込み条件を指定します。

帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”

この条件で絞り込みを行わない場合は、「null」を指定します。

sortOrder：

取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。

ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。

例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定したソート項目でソートが行われます。

「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。

ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”

startPosition：

部分取得する際の取得開始位置を指定します。

「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです)。

帳票一覧取得時に指定する絞り込み条件（condition)に一致するこの論理あて先に出力された帳票の件数より大きい値を指定した場合は、取得件数が0件になります。

resultLimit：: 最大取得件数を指定します。「0」以下を指定した場合は無制限に取得します。帳票一覧取得時に指定する絞り込み条件（condition)に一致するこの論理あて先に出力された帳票の件数より大きい値を指定した場合は、絞り込み条件に一致するこの論理あて先に出力された帳票の件数分だけ取得し、例外は発生しません。

戻り値

論理あて先内の帳票一覧

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。

備考

このメソッドで帳票を取得すると、LMUserInfo クラスのgetLastViewLD メソッドで取得できる値（ユーザが最後に帳票を取得/ 検索した論理あて先名）が更新されます。

public int

getFormsCount(FormFilterCondition condition)

throws OperateException, java.lang.IllegalStateException

用途

帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得します。

パラメータ

condition：

帳票の絞り込み条件を指定します。

帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”

この条件で絞り込みを行わない場合は、「null」を指定します。

戻り値

指定した条件に一致する帳票の総件数

例外

OperateException：: 取得処理でエラーが発生した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

public void

resumeAllForms(boolean isContinue)

throws OperateAllFormsException,java.lang.IllegalStateException

用途

論理あて先内の帳票の出力を一括して保留解除します。

帳票の出力状態が「出力保留」の帳票に対して、帳票の出力の保留を解除して帳票を出力します。

帳票の出力状態が「出力保留」以外の帳票に対しては無効です。

パラメータ

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
List Managerが開始されていない状態の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。

⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票の出力を一括して保留解除するには、論理あて先に対する表示権限および操作権限が必要です。

備考

帳票の出力状態が「出力保留」の帳票が論理あて先内に存在しない場合、例外は発生しません。

public void

resumeAllForms(boolean isContinue,LMParametersList printoutOptions)

throws OperateAllFormsException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

印刷部数、メッセージ通知先を指定して、論理あて先内の帳票の出力を一括して保留解除します。

パラメータ

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

printoutOptions：

印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。

PARAM_PRINTOUT_COPY（印刷部数）
帳票出力時の印刷部数をIntegerオブジェクトで指定します。
指定可能な印刷部数は1～ 999の範囲です。
- 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーションで指定した印刷部数が有効になります。
- 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。
PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
List Manager が開始されていない状態の場合

java.lang.Illegal ArgumentException：

printoutOptionsパラメータの各キーに「null」が指定された場合
printoutOptions パラメータに指定できないキーを指定した場合
printoutOptions パラメータに有効なキーが存在しない場合
印刷部数の値として、Integerオブジェクト以外が指定された場合
印刷部数に0～999以外の値を指定した場合
メッセージ通知先の値としてStringオブジェクト以外を指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。

⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票の出力を一括して保留解除するには、論理あて先に対する表示権限および操作権限が必要です。
出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項については、以下を参照してください。
⇒“●出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項”
出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項ついては、以下を参照してください。
⇒“●出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項”
printoutOptionsパラメータに「null」を指定した場合は、印刷部数に「0」が指定されたとみなされ、メッセージ通知先は帳票登録時のメッセージ通知先となります。

備考

帳票の出力状態が「出力保留」の帳票が論理あて先内に存在しない場合、例外は発生しません。
メッセージ通知先に、複数の通知先を指定することはできません。

public void

cancelAllForms(boolean isContinue)

throws OperateAllFormsException,java.lang.IllegalStateException

用途

論理あて先内の帳票の出力を一括して中止します。

論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。

帳票の出力中止が完了すると、帳票の出力状態が「中止」に変更されます。

パラメータ

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
帳票出力サーバと通信できない状態で、すでに帳票出力サーバに配信済みの帳票に対して、この指定を実行した場合
List Managerが開始されていない状態の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票の出力を一括して中止するには、論理あて先に対する表示権限および操作権限が必要です。
帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。

備考

帳票出力サーバの環境設定ファイルのTcpReqIntervalキーに指定した値により、帳票の出力中止が完了しても帳票の出力状態がすぐに更新されない場合があります。

public void

forceCancelAllForms(boolean isContinue)

throws OperateAllFormsException,java.lang.IllegalStateException

用途

論理あて先内の帳票の出力を、一括して強制的に中止します。

論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。

パラメータ

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
List Managerが開始されていない状態の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票の出力を一括して強制的に中止するには、論理あて先に対する表示権限および操作権限が必要です。
帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。

備考

出力の強制中止を行った場合、帳票出力サーバにおける出力状況、帳票出力サーバとの通信状態にかかわらず、List Manager管理データベース上の帳票の出力状態を強制的に「中止」にします。そのため、帳票出力サーバに配信中、または帳票出力サーバで出力中の帳票はそのまま処理が続行される場合があります。

public void

deleteAllForms(boolean isContinue)

throws OperateAllFormsException,java.lang.IllegalStateException

用途

論理あて先内の帳票を一括して削除します。

パラメータ

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
List Managerが開始されていない状態の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を一括して削除するには、論理あて先に対する表示権限および操作権限が必要です。
帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。

public void

copyAllForms(java.lang.String toLogicalDestinationName,boolean isOutput,boolean isContinue)

throws OperateAllFormsException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

論理あて先内の帳票を一括して複写します。

複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestination：

複写先の論理あて先名を指定します。

論理あて先グループを複写先論理あて先にすることはできません。

isOutput：

複写後に、帳票を出力するかどうかを指定します。

true：: 帳票を出力する場合に指定します。

false：: 帳票を出力しない場合に指定します。

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
複写元論理あて先または複写先論理あて先が存在しない場合
複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
複写先に、異なる論理あて先タイプの論理あて先を指定した場合
List Managerが開始されていない状態の場合
Web手元印刷型の場合で、以下の条件をすべて満たすとき
- Web手元印刷（OWFファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutputパラメータに「true」を指定した場合）
- 複写元と複写先で、帳票を出力するフォルダが同一である
- 複写元の帳票が出力先のフォルダに存在する
複写する帳票が1つも存在しなかった場合
複写先論理あて先に論理あて先グループを指定した場合

java.lang.Illegal ArgumentException：: 複写先の論理あて先名が「null」の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を一括して複写するには、複写元論理あて先および複写先論理あて先の両方に、論理あて先に対する表示権限および操作権限が必要です。

備考

複写できる帳票が論理あて先内に存在しない場合、例外は発生しません。
複写先論理あて先に、すでに同じ帳票が存在していた場合は複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）は、複写先論理あて先の帳票が出力されます。複写元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の初期状態は「登録」となります。
論理あて先の論理あて先タイプがWeb手元印刷用の場合、以下のようになります。
- 帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。このため、複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で出力されます。
- 複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デバイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。

public void

copyAllForms(java.lang.String toLogicalDestinationName, boolean isOutput,boolean isContinue,LMParametersList printoutOptions)

throws OperateAllFormsException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

論理あて先内の帳票の出力を一括して複写します。

複写と同時に出力を行う場合、印刷部数、メッセージ通知先を指定します。

複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestination Name：: 複写先の論理あて先名を指定します。
論理あて先グループを複写先論理あて先にすることはできません。

isOutput：

複写後に、複写した帳票の出力を行うかどうかを指定します。

true：: 複写後に帳票を出力する場合に指定します。

false：: 複写後に帳票を出力しない場合に指定します。

isContinue：

処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。

true：: エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。

false：: エラーが発生した時点で、処理を終了する場合に指定します。

printoutOptions：

印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）に有効になります。

PARAM_PRINTOUT_COPY（印刷部数）
帳票出力時の印刷部数をIntegerオブジェクトで指定します。
指定可能な印刷部数は1～ 999の範囲です。
- 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーションで指定した印刷部数が有効になります。
- 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。
PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
通知メッセージの通知先として、「ホスト名」または「IPアドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

例外

OperateAllForms Exception：

一括処理でエラーが発生した場合
複写元論理あて先または複写先論理あて先が存在しない場合
複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
複写先に、異なる論理あて先タイプの論理あて先を指定した場合
List Managerが開始されていない状態の場合
Web手元印刷型の場合で、以下の条件をすべて満たすとき
- Web手元印刷（OWFファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutputパラメータに「true」を指定した場合）
- 複写元と複写先で、帳票を出力するフォルダが同一である
- 複写元の帳票が出力先のフォルダに存在する
複写する帳票が1つも存在しなかった場合
複写先論理あて先に論理あて先グループを指定した場合

java.lang.Illegal ArgumentException：

複写先の論理あて先名が「null」の場合
printoutOptionsパラメータの各キーに「null」が指定された場合
printoutOptions パラメータに指定できないキーを指定した場合
printoutOptions パラメータに有効なキーが存在しない場合
印刷部数の値として、Integerオブジェクト以外が指定された場合
印刷部数に0～999以外の値を指定した場合
メッセージ通知先の値としてStringオブジェクト以外を指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

論理あて先内の帳票を一括して複写するには、複写元論理あて先、および複写先論理あて先の両方に、論理あて先に対する表示権限および操作権限が必要です。
printoutOptionsパラメータに「null」を指定した場合は、印刷部数に「0」が指定されたとみなされ、メッセージ通知先は帳票登録時のメッセージ通知先となります。

備考

複写できる帳票が論理あて先内に存在しない場合、例外は発生しません。
複写先論理あて先に、すでに同じ帳票が存在していた場合は複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）は、複写先論理あて先の帳票が出力されます。複写元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の初期状態は「登録」となります。
論理あて先の論理あて先タイプがWeb 手元印刷用の場合、以下のようになります。
- 帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。このため、複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で出力されます。
- 複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デバイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
メッセージ通知先に、複数の通知先を指定することはできません。

メソッドの概要
java.lang.String	getName() 論理あて先名を取得します。
java.lang.String	getComment() 論理あて先のコメントを取得します。
int	getType() 論理あて先の論理あて先タイプを取得します。
int	getPriority() 論理あて先の優先度を取得します。
java.lang.String	getDeviceName() 論理あて先に対応付けされている論理デバイス名を取得します。
java.lang.String	getDeviceComment() 論理あて先に関連付けされている論理デバイスのコメント（出力先）を取得します。
int	getOutputMethod() 論理あて先に対応付けされている論理デバイスの出力方法を取得します。
boolean	isActive() 論理あて先の状態を取得します。
int	getOutputMode() 帳票作成後の出力指定を取得します。
int	getKeepMode() 帳票出力後の保存指定を取得します。
int	getKeepDays() 論理あて先内の帳票の保存日数の指定を取得します。
java.lang.String	getCustomizeItem1() 論理あて先のカスタマイズ項目1を取得します。
java.lang.String	getCustomizeItem2() 論理あて先のカスタマイズ項目2を取得します。
java.lang.String	getCustomizeItem3() 論理あて先のカスタマイズ項目3を取得します。
java.lang.String	getCustomizeItem4() 論理あて先のカスタマイズ項目4を取得します。
java.lang.String	getCustomizeItem5() 論理あて先のカスタマイズ項目5を取得します。
int	getErrorStatus() 論理あて先の出力エラー状態を取得します。
void	start() 論理あて先を起動します。
void	stop() 論理あて先を停止します。
void	changeDevice(LogicalDevice device) 論理あて先に対応付けされている出力先（論理デバイス）を切り替えます。
Form	getForm(java.lang.String formID) 帳票IDを指定して、論理あて先内の帳票を取得します。
Form[]	getForms(SortOrder[] sortOrder) 論理あて先内の帳票を取得します。
ListResult	getForms(SortOrder[] sortOrder,int resultLimit) 最大取得件数を指定して、論理あて先内の帳票を取得します。
Form[]	getForms(FormFilterCondition condition,SortOrder[] sortOrder) 帳票の絞り込み条件を指定して、論理あて先内の帳票を取得します。
ListResult	getForms(FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit) 帳票の絞り込み条件、および最大取得件数を指定して、論理あて先内の帳票を取得します。
ListResult	getForms(FormFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit) 帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、論理あて先内の帳票を取得します。
int	getFormsCount(FormFilterCondition condition) 帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得します。
void	resumeAllForms(boolean isContinue) 論理あて先内の帳票の出力を一括して保留解除します。
void	resumeAllForms(boolean isContinue,LMParametersList printoutOptions) 印刷部数、メッセージ通知先を指定して、論理あて先内の帳票の出力を一括して保留解除します。
void	cancelAllForms(boolean isContinue) 論理あて先内の帳票の出力を一括して中止します。
void	forceCancelAllForms(boolean isContinue) 論理あて先内の帳票の出力を、一括して強制的に中止します。
void	deleteAllForms(boolean isContinue) 論理あて先内の帳票を一括して削除します。
void	copyAllForms(java.lang.String toLogicalDestinationName,boolean isOutput,boolean isContinue) 論理あて先内の帳票を一括して複写します。複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
void	copyAllForms(java.lang.String toLogicalDestinationName, boolean isOutput,boolean isContinue,LMParametersList printoutOptions) 論理あて先内の帳票の出力を一括して複写します。複写と同時に出力を行う場合、印刷部数、メッセージ通知先を指定します。複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

3.7.2 LogicalDestinationクラス

3.7.2.1 フィールドの概要

3.7.2.2 メソッドの概要

3.7.2.3 メソッドの詳細