Interstage List Works for Modernization V11.0.0 帳票印刷配信機能アプリケーション作成ガイド 帳票管理編

3.8.2 LogicalDeviceクラス

論理デバイス情報を取得するクラスです。

java.lang.Object
  └com.fujitsu.listmanager.operate.LogicalDevice


public class LogicalDevice
extends java.lang.Object

3.8.2.1 フィールドの概要

LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールドを以下に示します。

LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド

定数	説明
OUTPUT_PRINTER_DOCUMENT_PUSH	出力方法は、帳票配信型の場合のプリンタ（印刷）です。
OUTPUT_LISTWORKS_ DOCUMENT_PUSH	出力方法は、帳票配信型の場合のList Works（電子保存(Interstage List Manager互換のための機能)）です。
OUTPUT_PDF_DOCUMENT_PUSH	出力方法は、帳票配信型の場合のPDF（PDFファイル保存）です。
OUTPUT_PDF_LOCAL_PRINT	出力方法は、Web手元印刷型の場合のPDF（PDFファイル）です。
OUTPUT_OWF_LOCAL_PRINT	出力方法は、Web手元印刷型の場合のOWF（OWFファイル）です。

LogicalDeviceクラスのgetPositionTypeメソッドで取得されるフィールドを以下に示します。

LogicalDeviceクラスのgetPositionTypeメソッドで取得されるフィールド

定数	説明
POSITION_TYPE_INCH	原点位置指定単位は、インチです。
POSITION_TYPE_MM	原点位置指定単位は、ミリメートルです。
POSITION_TYPE_UNKNOWN	原点位置指定単位は、未指定です。

LogicalDeviceクラスのgetDisplayMessageModeメソッドで取得されるフィールドを以下に示します。

このフィールドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。

LogicalDeviceクラスのgetDisplayMessageModeメソッドで取得されるフィールド

定数	説明
DISPLAY_MESSAGE_AUTO	用紙交換メッセージ表示指定は、「用紙変更時に自動で表示しない」です。
DISPLAY_MESSAGE_NECESSARY	用紙交換メッセージ表示指定は、「印刷開始時に必ず表示する」です。
DISPLAY_MESSAGE_NONE	用紙交換メッセージ表示指定は、「表示しない」です。
DISPLAY_MESSAGE_USE_FORM_ATTRIBUTE	用紙交換メッセージ表示指定は、「帳票属性の編集コマンド（lmedtformatrコマンド）で定義した用紙交換メッセージ表示指定にしたがう」です。

3.8.2.2 メソッドの概要

LogicalDeviceクラスのメソッドを以下に示します。

LogicalDeviceクラスのメソッド

メソッドの概要
java.lang.String	getName() 論理デバイス名を取得します。
int	getOutputMethod() 論理デバイスの出力方法を取得します。
java.lang.String	getHostName() 論理デバイスの通信対象コンピュータ名を取得します。
java.lang.String	getDeviceName() 論理デバイスの印刷プリンタ名を取得します。
java.lang.String	getOutputFolder() 論理デバイスの出力フォルダを取得します。
java.lang.String	getDbPath() 論理デバイスに定義されている、電子保存時の保管フォルダのパスを取得します。 本メソッドは、Interstage List Manager互換のための機能で使用します。
int	getPositionType() 論理デバイスの原点位置指定単位を取得します。
float	getPositionY() 論理デバイスの原点位置縦方向を取得します。
float	getPositionX() 論理デバイスの原点位置横方向を取得します。
java.lang.String	getComment() 論理デバイスのコメント（出力先）を取得します。
java.lang.String	getDivision() 論理デバイスの論理デバイス区分を取得します。
int	getDisplayMessageMode() 用紙交換メッセージ表示指定を取得します。 このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
java.lang.String	getSendMessageHostName() メッセージ通知先を取得します。 このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
java.lang.String	getPdfAttributeFileName() 帳票出力時に使用するPDF文書情報ファイル名を取得します。 このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
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を取得します。
java.lang.String	getCustomizeItem6() 論理デバイスのカスタマイズ項目6を取得します。
java.lang.String	getCustomizeItem7() 論理デバイスのカスタマイズ項目7を取得します。
java.lang.String	getCustomizeItem8() 論理デバイスのカスタマイズ項目8を取得します。

ポイント

各論理デバイス情報の定義については、オンラインマニュアル“帳票印刷配信機能  セットアップガイド”を参照してください。

3.8.2.3 メソッドの詳細

public java.lang.String

getName()

用途

論理デバイス名を取得します。

戻り値

論理デバイス名

public int

getOutputMethod()

用途

論理デバイスの出力方法を取得します。

戻り値

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

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

public java.lang.String

getHostName()

用途

論理デバイスの通信対象コンピュータ名を取得します。

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

• プリンタ（電子保存装置(Interstage List Manager互換のための機能で使用する装置)も含む）が定義されている接続先の「ホスト名」または「IPアドレス」

• PDFファイルを格納する接続先の「ホスト名」または「IPアドレス」

戻り値

通信対象コンピュータ名

なお、通信対象コンピュータ名が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getDeviceName()

用途

論理デバイスの印刷プリンタ名を取得します。

印刷プリンタ名は、帳票出力サーバに接続されている印刷プリンタ名です。なお、印刷プリンタには、電子保存装置(Interstage List Manager互換のための機能で使用する装置)も含まれます。

戻り値

印刷プリンタ名

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

public java.lang.String

getOutputFolder()

用途

論理デバイスの出力フォルダを取得します。

出力フォルダは、出力方法が「帳票配信型の場合のPDF（PDFファイル保存）」、「Web手元印刷型の場合のPDF（PDFファイル）」、および「Web手元印刷型の場合のOWF（OWFファイル）」の場合のフォルダ名です。

戻り値

出力フォルダ名

なお、論理デバイスの出力フォルダが指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getDbPath()

本メソッドは、出力方法に電子保存(Interstage List Manager互換のための機能)を指定する場合に使用します。

用途

論理デバイスに定義されている、電子保存時の保管フォルダのパスを取得します。

保管フォルダのパスは、帳票を電子保存するリスト管理サーバ上の保管フォルダのディレクトリ名です。

戻り値

電子保存時の保管フォルダパス名

なお、電子保存時の保管フォルダパス名が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public int

getPositionType()

用途

論理デバイスの原点位置指定単位を取得します。

帳票配信型の場合に、有効な値を取得することができます。

戻り値

原点位置指定単位を示すフィールドの中の1つ

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

public float

getPositionY()

用途

論理デバイスの原点位置縦方向を取得します。

帳票配信型の場合に、有効な値を取得することができます。

原点位置縦方向は、帳票出力時の縦方向からの原点位置です。

戻り値

原点位置縦方向

なお、原点位置縦方向が指定されていない場合は、「0」が取得されます。

public float

getPositionX()

用途

論理デバイスの原点位置横方向を取得します。

帳票配信型の場合に、有効な値を取得することができます。

原点位置横方向は、帳票出力時の横方向からの原点位置です。

戻り値

原点位置横方向

なお、原点位置横方向指定されていない場合は、「0」が取得されます。

public java.lang.String

getComment()

用途

論理デバイスのコメント（出力先）を取得します。

戻り値

コメント（出力先）

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

public java.lang.String

getDivision()

用途

論理デバイスの論理デバイス区分を取得します。

論理デバイス区分は、論理デバイスを分類するための区分です。

戻り値

論理デバイス区分

なお、論理デバイス区分が指定されていない場合、または半角空白だけの場合は「null」が取得されます。

public int

getDisplayMessageMode()

用途

用紙交換メッセージ表示指定を取得します。

出力方法が「帳票配信型の場合のプリンタ（印刷）」の場合に有効となります。

このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。

戻り値

用紙交換メッセージの表示方法を示すフィールドの中の1つ

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

public java.lang.String

getSendMessageHostName()

用途

メッセージ通知先を取得します。

メッセージ通知先は、通知メッセージを通知するコンピュータを示します。

このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。

戻り値

メッセージ通知先の「ホスト名」または「IPアドレス」

メッセージ通知先が設定されていない場合、または半角空白だけの場合は「null」が取得されます。

public java.lang.String

getPdfAttributeFileName()

用途

帳票出力時に使用するPDF文書情報ファイル名を取得します。

このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。

戻り値

帳票出力時に使用するPDF文書情報ファイルのフルパス

PDF文書情報ファイル名が設定されていない場合、または半角空白だけの場合は「null」が取得されます。

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 java.lang.String

getCustomizeItem6()

用途

論理デバイスのカスタマイズ項目6を取得します。

戻り値

カスタマイズ項目6

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

public java.lang.String

getCustomizeItem7()

用途

論理デバイスのカスタマイズ項目7を取得します。

戻り値

カスタマイズ項目7

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

public java.lang.String

getCustomizeItem8()

用途

論理デバイスのカスタマイズ項目8を取得します。

戻り値

カスタマイズ項目8

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