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

3.7.1 LogicalDestinationManagerクラス

論理あて先の取得/検索を行うクラスです。

検索時の検索条件は、LogicalDestinationFilterConditionクラスを使用して指定します。

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


public class LogicalDestinationManager
extends java.lang.Object

注意

このクラスのメソッドを使用して、論理あて先を取得するには、論理あて先に対する表示権限が必要です。

3.7.1.1 コンストラクタの概要

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

コンストラクタの概要

LogicalDestinationManager(LMUser user)

LogicalDestinationManagerクラスのLogicalDestinationManagerオブジェクトを生成します。

3.7.1.2 メソッドの概要

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

メソッドの概要
LogicalDestination[]	getLogicalDestinations(SortOrder[] sortOrder) 論理あて先の一覧を取得します。
LogicalDestination[]	getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder) 論理あて先の絞り込み条件を指定して、論理あて先の一覧を取得します。
java.lang.String[]	getLogicalDestinationNames() 論理あて先名の一覧を取得します。
ListResult	getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit) 論理あて先の絞り込み条件、取得開始位置、および最大取得件数を指定して論理あて先を取得します。
int	getLogicalDestinationsCount(LogicalDestinationFilterCondition condition) 論理あて先の絞り込み条件を指定して、指定した条件に一致する論理あて先の総件数を取得します。

ポイント

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

3.7.1.3 コンストラクタの詳細

public

LogicalDestinationManager(LMUser user)

throws java.lang.IllegalStateException

用途

LogicalDestinationManagerクラスのLogicalDestinationManagerオブジェクトを生成します。

認証したユーザが持つ論理あて先に対する権限が、このクラスに適用されます。

パラメータ

user：

UserAuthorizationクラスまたはLMUserManagerクラスで取得したユーザを指定します。

例外

java.lang.Illegal StateException：

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

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

3.7.1.4 メソッドの詳細

public LogicalDestination[]

getLogicalDestinations(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 セキュリティモードの設定”

public LogicalDestination[]

getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder)

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

用途

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

ユーザが持つ表示権限の範囲で、論理あて先を取得できます。

パラメータ

condition：

論理あて先を絞り込んで検索するときの条件を指定します。

論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”

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

sortOrder：

取得した取得した論理あて先をソートする場合、並べ替えのキーにするソート項目を指定します。

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

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

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

戻り値

条件に一致した論理あて先の配列

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

例外

OperateException：

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

java.lang.Illegal ArgumentException：

• 指定できないソート項目がある場合

• 同じソート項目を複数指定した場合

• ソート項目を6個以上指定した場合

java.lang.Illegal StateException：

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

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

public java.lang.String[]

getLogicalDestinationNames()

throws OperateException,java.lang.IllegalStateException

用途

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

ユーザが持つ表示権限の範囲で、論理あて先名を取得できます。

戻り値

表示権限のある論理あて先名の配列

なお、表示権限のある論理あて先がない場合は、長さ0の配列が取得されます。

例外

OperateException：

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

java.lang.Illegal StateException：

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

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

public ListResult

getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)

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

用途

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

最大取得件数は取得する論理あて先の最大数です。

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

パラメータ

condition：

論理あて先を絞り込んで検索するときの条件を指定します。

論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”

この条件で絞り込みを行わない場合は、「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 セキュリティモードの設定”

注意

• 論理あて先の総件数を取得するには、論理あて先に対する表示権限が必要です。

public int

getLogicalDestinationsCount(LogicalDestinationFilterCondition condition)

throws OperateException, java.lang.IllegalStateException

用途

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

パラメータ

condition：

論理あて先を絞り込んで検索するときの条件を指定します。

論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”

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

戻り値

指定した条件に一致する論理あて先の総件数

例外

OperateException：

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

java.lang.Illegal StateException：

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

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

注意

• 実行ユーザが表示権限を持たない論理あて先の件数はカウントされません。