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

3.7.3 LogicalDestinationFilterConditionクラス

論理あて先を検索するときの検索条件を指定するクラスです。

LogicalDestinationManagerクラスで使用します。

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


public class LogicalDestinationFilterCondition
extends java.lang.Object

ポイント

• 検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカード文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われない場合があります。

• 検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、空白が設定されている情報を絞り込むことはできません。

3.7.3.1 フィールドの概要

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

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

定数	説明
NOT_SPECIFIED	条件を特定しない場合に指定します。

3.7.3.2 コンストラクタの概要

LogicalDestinationFilterConditionクラスのコンストラクタを以下に示します。

LogicalDestinationFilterConditionクラスのコンストラクタ

コンストラクタの概要

LogicalDestinationFilterCondition()

LogicalDestinationFilterConditionオブジェクトを生成します。

3.7.3.3 メソッドの概要

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

LogicalDestinationFilterConditionクラスのメソッド

メソッドの概要
java.lang.String	getName() 論理あて先の絞り込み条件として設定されている、論理あて先名を取得します。
int	getType() 論理あて先の絞り込み条件として設定されている、論理あて先タイプを取得します。
int	getPriority() 論理あて先の絞り込み条件として設定されている、優先度を取得します。
java.lang.String	getDeviceName() 論理あて先の絞り込み条件として設定されている、論理デバイス名を取得します。
java.lang.String	getDeviceComment() 論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスのコメント（出力先）を取得します。
int[]	getOutputMethod() 論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスの出力方法を取得します。
java.lang.Boolean	getActive() 論理あて先の絞り込み条件として設定されている、論理あて先の状態を取得します。
int	getErrorStatus() 論理あて先の絞り込み条件として設定されている、出力エラー状態を取得します。
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を取得します。
void	setName(java.lang.String name) 論理あて先の絞り込み条件として、論理あて先名を指定します。
void	setType(int type) 論理あて先の絞り込み条件として、論理あて先タイプを指定します。
void	setPriority(int priority) 論理あて先の絞り込み条件として、優先度を指定します。
void	setDeviceName(java.lang.String deviceName) 論理あて先の絞り込み条件として、論理デバイス名を指定します。
void	setDeviceComment(java.lang.String deviceComment) 論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスのコメント（出力先）を指定します。
void	setOutputMethod(int[] outputMethod) 論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスの出力方法を指定します。
void	setActive(java.lang.Boolean active) 論理あて先の絞り込み条件として、論理あて先の状態を指定します。
void	setErrorStatus(int errorStatus) 論理あて先の絞り込み条件として、出力エラー状態を指定します。
void	setCustomizeItem1(java.lang.String customizeItem1) 論理あて先の絞り込み条件として、カスタマイズ項目1を指定します。
void	setCustomizeItem2(java.lang.String customizeItem2) 論理あて先の絞り込み条件として、カスタマイズ項目2を指定します。
void	setCustomizeItem3(java.lang.String customizeItem3) 論理あて先の絞り込み条件として、カスタマイズ項目3を指定します。
void	setCustomizeItem4(java.lang.String customizeItem4) 論理あて先の絞り込み条件として、カスタマイズ項目4を指定します。
void	setCustomizeItem5(java.lang.String customizeItem5) 論理あて先の絞り込み条件として、カスタマイズ項目5を指定します。

ポイント

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

3.7.3.4 コンストラクタの詳細

public

LogicalDestinationFilterCondition()

用途

LogicalDestinationFilterConditionオブジェクトを生成します。

3.7.3.5 メソッドの詳細

public java.lang.String

getName()

用途

論理あて先の絞り込み条件として設定されている、論理あて先名を取得します。

戻り値

論理あて先名

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public int

getType()

用途

論理あて先の絞り込み条件として設定されている、論理あて先タイプを取得します。

戻り値

LogicalDestinationクラスの論理あて先タイプを示すフィールド

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

なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。

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

public int

getPriority()

用途

論理あて先の絞り込み条件として設定されている、優先度を取得します。

戻り値

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

なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。

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

public java.lang.String

getDeviceName()

用途

論理あて先の絞り込み条件として設定されている、論理デバイス名を取得します。

戻り値

論理デバイス名

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.String

getDeviceComment()

用途

論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスのコメント（出力先）を取得します。

戻り値

コメント（出力先）

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public int[]

getOutputMethod()

用途

論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスの出力方法を取得します。

戻り値

LogicalDeviceクラスの出力方法を示すフィールドの配列

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

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.Boolean

getActive()

用途

論理あて先の絞り込み条件として設定されている、論理あて先の状態を取得します。

戻り値

Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：

「起動中」が条件の場合

Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：

「停止中」が条件の場合

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public int

getErrorStatus()

用途

論理あて先の絞り込み条件として設定されている、出力エラー状態を取得します。

戻り値

LogicalDestinationクラスの出力エラー状態を示すフィールド

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

なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。

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

public java.lang.String

getCustomizeItem1()

用途

論理あて先の絞り込み条件として設定されている、カスタマイズ項目1を取得します。

戻り値

カスタマイズ項目1

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.String

getCustomizeItem2()

用途

論理あて先の絞り込み条件として設定されている、カスタマイズ項目2を取得します。

戻り値

カスタマイズ項目2

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.String

getCustomizeItem3()

用途

論理あて先の絞り込み条件として設定されている、カスタマイズ項目3を取得します。

戻り値

カスタマイズ項目3

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.String

getCustomizeItem4()

用途

論理あて先の絞り込み条件として設定されている、カスタマイズ項目4を取得します。

戻り値

カスタマイズ項目4

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public java.lang.String

getCustomizeItem5()

用途

論理あて先の絞り込み条件として設定されている、カスタマイズ項目5を取得します。

戻り値

カスタマイズ項目5

なお、絞り込み条件が指定されていない場合は「null」が取得されます。

public void

setName(java.lang.String name)

用途

論理あて先の絞り込み条件として、論理あて先名を指定します。

パラメータ

name：

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

論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。

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

public void

setType(int type)

throws java.lang.IllegalArgumentException

用途

論理あて先の絞り込み条件として、論理あて先タイプを指定します。

パラメータ

type：

LogicalDestinationクラスの論理あて先タイプを示すフィールドを指定します。

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

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

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

例外

java.lang.Illegal ArgumentException：

無効な論理あて先タイプを指定した場合

public void

setPriority(int priority)

throws java.lang.IllegalArgumentException

用途

論理あて先の絞り込み条件として、優先度を指定します。

パラメータ

priority：

優先度を示す数値1（優先度：低）～10（優先度：高）を指定します。

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

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

例外

java.lang.Illegal ArgumentException：

無効な優先度を指定した場合

public void

setDeviceName(java.lang.String deviceName)

用途

論理あて先の絞り込み条件として、論理デバイス名を指定します。

パラメータ

deviceName：

論理デバイス名を指定します。

論理デバイス名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。

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

public void

setDeviceComment(java.lang.String deviceComment)

用途

論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスのコメント（出力先）を指定します。

パラメータ

deviceComment：

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

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

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

public void

setOutputMethod(int[] outputMethod)

throws java.lang.IllegalArgumentException

用途

論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスの出力方法を指定します。

パラメータ

outputMethod：

LogicalDeviceクラスの出力方法を示すフィールドを指定します。出力方法は複数指定できます。複数指定した場合は論理和条件（OR条件）となります。

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

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

例外

java.lang.Illegal ArgumentException：

• 無効な出力方法を指定した場合

• 同じ出力方法を複数指定した場合

public void

setActive(java.lang.Boolean active)

用途

論理あて先の絞り込み条件として、論理あて先の状態を指定します。

パラメータ

active：

論理あて先の状態を指定します。

Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：

「起動中」の論理あて先を絞り込む場合に指定します。

Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：

「停止中」の論理あて先を絞り込む場合に指定します。

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

public void

setErrorStatus(int errorStatus)

throws java.lang.IllegalArgumentException

用途

論理あて先の絞り込み条件として、出力エラー状態を指定します。

パラメータ

errorStatus：

LogicalDestinationクラスの出力エラー状態を示すフィールドを指定します。

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

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

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

例外

java.lang.Illegal ArgumentException：

無効な出力エラー状態を指定した場合

public void

setCustomizeItem1(java.lang.String customizeItem1)

用途

論理あて先の絞り込み条件として、カスタマイズ項目1を指定します。

パラメータ

customizeItem1：

カスタマイズ項目1を指定します。

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

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

public void

setCustomizeItem2(java.lang.String customizeItem2)

用途

論理あて先の絞り込み条件として、カスタマイズ項目2を指定します。

パラメータ

customizeItem2：

カスタマイズ項目2を指定します。

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

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

public void

setCustomizeItem3(java.lang.String customizeItem3)

用途

論理あて先の絞り込み条件として、カスタマイズ項目3を指定します。

パラメータ

customizeItem3：

カスタマイズ項目3を指定します。

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

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

public void

setCustomizeItem4(java.lang.String customizeItem4)

用途

論理あて先の絞り込み条件として、カスタマイズ項目4を指定します。

パラメータ

customizeItem4：

カスタマイズ項目4を指定します。

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

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

public void

setCustomizeItem5(java.lang.String customizeItem5)

用途

論理あて先の絞り込み条件として、カスタマイズ項目5を指定します。

パラメータ

customizeItem5：

カスタマイズ項目5を指定します。

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

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