ページの先頭行へ戻る
Interstage List Works V10.4.0 帳票保管活用機能APIリファレンス(拡張パッケージ)
FUJITSU Software

3.2.3 Javaクラス(ListConfig)

以下に、Javaクラス(ListConfig)のメソッドを示します。

メソッド

機能

addSheetPath

帳票の論理パスの追加

compareKeepCheckInfo

帳票が選択中かどうかの判定

getActivePage

現在表示している帳票のページ番号の取得

getApplicationURL

Web連携機能のURLを取得 (注1)

getBrosKeepFolderInfoNo

次に存在する同一階層の保管フォルダ情報の番号取得

getByteSwap

バイトスワップフラグの取得

getChildKeepFolderInfoNo

子の保管フォルダ情報の番号取得

getClassFolderNoList

階層のフォルダ番号リストの取得

getClassNameList

階層のフォルダ名リストの取得

getConnectForm

連結できる最大帳票数の取得

getConnectServer

リスト管理サーバ接続フラグの取得

getCurrentFolderAttribute

現在選択している保管フォルダの情報の取得

getCurrentFolderNameList

最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストの取得

getEndNo

帳票一覧の最後の番号の取得

getFindListConditionIndex

帳票一覧の検索で、あらかじめ設定されている抜き出し検索範囲を使用するかどうかの取得

getFindTargetList

リスト管理サーバに保存されている、検索する対象範囲(抜き出し検索範囲)一覧の取得

getFindTargetSectionList

検索する対象範囲(抜き出し検索範囲)のセクション名の一覧の取得

getFolderNo

選択している保管フォルダ番号の取得

getGroupCount

所属グループの種別番号の取得

getHitTotalSheetNo

選択した保管フォルダ内の表示条件に該当する帳票の総数の取得

getKeepFolderAttribute

保管フォルダ情報の取得

getKeepFolderInfoNo

保管フォルダ情報の番号の取得

getKeepSheetAttribute

保管フォルダ内帳票情報の取得

getKeepSheetInfoNo

保管フォルダ内帳票の番号の取得

getNextKeepFolderInfoNo

次に存在する同一階層、それがない場合は親と同一階層で、次に存在する保管フォルダ情報の番号の取得

getListPrintPropertiesName

ListPrint.propertiesのファイル名を取得

getPollingPrintWatchTime

ポーリング印刷における帳票一覧の監視時間の取得

getRemoteAddr

処理を要求したクライアントのホストIPアドレスの取得

getRemoteHost

処理を要求したクライアントのホスト名、または処理を要求したクライアントのホストIPアドレスの取得

getSeparatorMark

フォルダ区切りマークの取得

getServerAddr

リスト管理サーバIPアドレスの取得

getServerName

リスト管理サーバ名の取得

getServletURL

ListGatewayのURLを取得 (注1)

getSession

セションの取得

getSessionID

セションIDの取得

getSheetNo

選択した帳票の番号の取得

getSheetPath

帳票の論理パスの取得

getStartNo

帳票一覧の最初の番号の取得

getTotalFolderNo

保管フォルダの総数の取得

getTotalSheetNo

帳票の総数の取得

getUsePdfSheet

PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を使用するかどうかの取得

getUsePrintedSheet

ローカル印刷識別を利用するかどうかの取得 (注2)

getUserID

ユーザIDを取得

getViewNo

帳票一覧に表示できる最大帳票数の取得

getViewSheetNo

表示する帳票の数の取得

setFolderPath

保管フォルダの論理パスを設定

setListPrintPropertiesName

ListPrint.propertiesのファイル名を設定

setSheetPath

帳票の論理パスの設定

注1:ListWORKS、およびList Works V6.0L10/6.0から移行した場合に、プログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。

注2:Windows版およびSolaris版の機能です。


3.2.3.1 addSheetPath(帳票の論理パスの追加)

記述形式

listConfig.addSheetPath(帳票の論理パス)

機能

リスト管理サーバ上での帳票の論理パスを追加します。


パラメタの説明

帳票の論理パス

帳票の論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。

例)Windows版の場合
    保管フォルダの論理パスが「C:\営業部」、帳票のファイル名が「ABC.spl」の場合
      C:\営業部\ABC.spl
   Solaris版/Linux版の場合
    保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合
      /eigyo/ABC.spl

復帰値

true

帳票の論理パスを追加しました。

false

帳票の論理パスを追加できませんでした。


使用例

Windows版の場合

帳票の論理パス「C:\営業\DEF.spl」を追加します。

  String strPath = new String("C:\\営業\\ABC.spl");
  listConfig.setSheetPath(strPath.getBytes("MS932"));
  strPath = new String("C:\\営業\\DEF.spl");
  listConfig.addSheetPath(strPath.getBytes("MS932"));
Solaris版/Linux版の場合

帳票の論理パス「/eigyo/DEF.spl」を追加します。

  String strPath = new String("/eigyo/ABC.spl");
  listConfig.setSheetPath(strPath.getBytes("MS932"));
  strPath = new String("/eigyo/DEF.spl");
  listConfig.addSheetPath(strPath.getBytes("MS932"));

3.2.3.2 compareKeepCheckInfo(帳票が選択中かどうかの判定)

記述形式

listConfig.compareKeepCheckInfo(ファイル名)

機能

帳票が選択中(帳票一覧で、帳票のチェックボックスがチェックされた状態)かどうか判定します。


パラメタの説明

ファイル名

java.lang.String型で帳票のファイル名を指定します。
必ず指定します。


復帰値

true

選択中です。

false

選択中ではありません。


使用例

帳票が選択中かどうか判定します。

  listConfig.compareKeepCheckInfo("ABC.spl");

3.2.3.3 getActivePage(現在表示している帳票のページ番号の取得)

記述形式

listConfig.getActivePage()

機能

現在表示している帳票のページ番号を取得します。


パラメタの説明

なし


復帰値

使用例

現在表示している帳票のページ番号を取得します。

  listConfig.getActivePage();

注意

  • このメソッドは、一覧からの印刷画面および、帳票を表示している場合のみ有効です。

  • キャッシュされていないページを表示した場合のみ有効です。


3.2.3.4 getApplicationURL(Web連携機能のURLを取得)

ポイント

互換

getApplicationURLメソッドは、ListWORKS、およびList Works V6.0L10/6.0から移行した場合に、プログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。


記述形式

listConfig.getApplicationURL()

機能

List WorksのWeb連携機能(Webアプリケーション)のURLを取得します。


パラメタの説明

なし


復帰値

使用例

List WorksのWeb連携機能(Webアプリケーション)のURLを取得します。

  listConfig.getApplicationURL();

3.2.3.5 getBrosKeepFolderInfoNo(次に存在する同一階層の保管フォルダ情報の番号取得)

記述形式

listConfig.getBrosKeepFolderInfoNo(保管フォルダ情報の番号)

機能

次に存在する同一階層の保管フォルダ情報の番号を取得します。

パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

使用例

0番の保管フォルダの次に存在する同一階層の保管フォルダ情報の番号を取得します。

  listConfig.getBrosKeepFolderInfoNo(0);

3.2.3.6 getByteSwap(バイトスワップフラグの取得)

記述形式

listConfig.getByteSwap()

機能

バイトスワップフラグを取得します。


パラメタの説明

なし


復帰値

true

バイトスワップフラグを取得しました。

false

バイトスワップフラグを取得できませんでした。


使用例

バイトスワップフラグを取得します。

  listConfig.getByteSwap();

3.2.3.7 getChildKeepFolderInfoNo(子の保管フォルダ情報の番号取得)

記述形式

listConfig.getChildKeepFolderInfoNo(保管フォルダ情報の番号)

機能

子の保管フォルダ情報の番号を取得します。直下に保管フォルダが複数ある場合は、最初の保管フォルダ情報の番号を取得します。

パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

使用例

0番の保管フォルダにおける、子の保管フォルダ情報の番号を取得します。

  listConfig.getChildKeepFolderInfoNo(0);

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。


3.2.3.8 getClassFolderNoList(階層のフォルダ番号リストの取得)

記述形式

listConfig.getClassFolderNoList(保管フォルダ情報の番号)

機能

最上位の親保管フォルダから、指定した保管フォルダ番号までの階層のフォルダ番号リストを取得します。

パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

使用例

最上位の保管フォルダから10番目の保管フォルダまでの階層のフォルダ番号リストを取得します。

  listConfig.getClassFolderNoList(10);

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。


3.2.3.9 getClassNameList(階層のフォルダ名リストの取得)

記述形式

listConfig.getClassNameList(保管フォルダ情報の番号)

機能

最上位の親保管フォルダから、指定した保管フォルダ番号までのフォルダ名リストを取得します。

パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

使用例

最上位の保管フォルダから10番目の保管フォルダまでの階層のフォルダ名リストを取得します。

  listConfig.getClassNameList(10);

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。


3.2.3.10 getConnectForm(連結できる最大帳票数の取得)

記述形式

listConfig.getConnectForm()

機能

連結表示できる最大帳票数を取得します。


パラメタの説明

なし


復帰値

int型の連結表示できる最大帳票数


使用例

連結表示できる最大帳票数を取得します。

  listConfig.getConnectForm();

3.2.3.11 getConnectServer(リスト管理サーバ接続フラグの取得)

記述形式

listConfig.getConnectServer()

機能

リスト管理サーバに接続しているかどうかの判定を取得します。


パラメタの説明

なし


復帰値

true

接続しています。

false

接続していません。


使用例

リスト管理サーバ接続フラグを取得します。

  listConfig.getConnectServer();

3.2.3.12 getCurrentFolderAttribute(現在選択している保管フォルダの情報の取得)

記述形式

listConfig.getCurrentFolderAttribute()

機能

現在選択している保管フォルダの情報を取得します。


パラメタの説明

なし


復帰値

使用例

現在選択している保管フォルダの情報を取得します。

  listConfig.getCurrentFolderAttribute();

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドのrangeパラメタに「2」、「3」または「4」を指定して実行した場合のみ有効です。


3.2.3.13 getCurrentFolderNameList(最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストの取得)

記述形式

listConfig.getCurrentFolderNameList()

機能

最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストを取得します。


パラメタの説明

なし


復帰値

使用例

最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストを取得します。

  listConfig.getCurrentFolderNameList();

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドのrangeパラメタに「2」、「3」または「4」を指定して実行した場合のみ有効です。


3.2.3.14 getEndNo(帳票一覧の最後の番号の取得)

記述形式

listConfig.getEndNo()

機能

帳票一覧の最後の番号を取得します。


パラメタの説明

なし


復帰値

使用例

帳票一覧の最後の番号を取得します。

  listConfig.getEndNo();

3.2.3.15 getFindListConditionIndex(帳票一覧の検索で、あらかじめ設定されている抜き出し検索範囲を使用するかどうかの取得)

記述形式

listConfig.getFindListConditionIndex()

機能

帳票一覧での検索で、あらかじめ設定されている抜き出し検索範囲を使用するかどうかを取得します。


パラメタの説明

なし


復帰値

true

帳票一覧の検索で、あらかじめ設定されている抜き出し検索範囲を使用する

false

帳票一覧の帳票で、あらかじめ設定されている抜き出し検索範囲を使用しない


使用例

帳票一覧の検索で、あらかじめ設定されている抜き出し検索範囲を使用するかどうかを取得します。

  listConfig.getFindListConditionIndex();

3.2.3.16 getFindTargetList(リスト管理サーバに保存されている、検索する対象範囲(抜き出し検索範囲)一覧の取得)

記述形式

listConfig.getFindTargetList( [セクション名] )

機能

リスト管理サーバに保存されている、検索する対象範囲(抜き出し検索範囲)の一覧を取得します。


パラメタの説明

セクション名

検索する対象範囲(抜き出し検索範囲)の一覧を取得するセクション名を、半角255文字以内のjava.lang.String型で指定します。
省略可能です。省略した場合は、「default」セクションが指定されたものと見なします。


復帰値

com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、検索する対象範囲(抜き出し検索範囲)の一覧

指定されたセクションが存在しない場合、または検索する対象範囲(抜き出し検索範囲)の一覧の取得準備を行っていない場合は、要素数0のObjectList


使用例

セクション名「default」に設定されている、検索する対象範囲(抜き出し検索範囲)の一覧を取得します。

  listConfig.getFindTargetList();

セクション名「123」に設定されている、検索する対象範囲(抜き出し検索範囲)の一覧を取得します。

  listConfig.getFindTargetList(“123”);

ポイント

  • lwfndtgtコマンドで設定したときの入力ファイルに記述した順序で、文字列のリストが取得されます。

  • 取得される一覧には、「すべての抜き出し検索範囲」および「印刷データ全体」は含まれません。

注意

本APIを実行する前に、同一セクション名に対する、検索する対象範囲(抜き出し検索範囲)の一覧の取得準備を行う必要があります。


3.2.3.17 getFindTargetSectionList(検索する対象範囲(抜き出し検索範囲)のセクション名の一覧の取得)

記述形式

listConfig.getFindTargetSectionList()

機能

リスト管理サーバに保存されている、検索する対象範囲(抜き出し検索範囲)のセクション名の一覧を取得します。

パラメタの説明

なし

復帰値

com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、検索する対象範囲(抜き出し検索範囲)のセクション名の一覧


使用例

検索する対象範囲(抜き出し検索範囲)のセクション名の一覧を取得します。

  listConfig.getFindTargetList();

注意

本APIを実行する前に、帳票一覧の表示準備(openframeコマンド)を行う必要があります。


3.2.3.18 getFolderNo(選択している保管フォルダ番号の取得)

記述形式

listConfig.getFolderNo()

機能

選択している保管フォルダ番号を取得します。


パラメタの説明

なし


復帰値

int型の選択している保管フォルダ番号


使用例

選択している保管フォルダ番号を取得します。

  listConfig.getFolderNo();

3.2.3.19 getGroupCount(所属グループの種別番号の取得)

記述形式

listConfig.getGroupCount()

機能

リスト管理サーバに接続中のユーザが所属しているグループの種別番号を取得します。


パラメタの説明

なし


復帰値

int型の、所属しているグループの種別番号

0以上

一般ユーザ

-1

管理者


使用例

所属しているグループの種別番号を取得します。

  listConfig.getGroupCount();

3.2.3.20 getHitTotalSheetNo(選択した保管フォルダ内の表示条件に該当する帳票の総数の取得)

記述形式

listConfig.getHitTotalSheetNo()

機能

選択した保管フォルダ内の表示条件に該当する帳票の総数を取得します。


パラメタの説明

なし


復帰値

int型の、選択した保管フォルダ内の表示条件に該当する帳票の総数


使用例

選択した保管フォルダ内の表示条件に該当する帳票の総数を取得します。

  listConfig.getHitTotalSheetNo();

3.2.3.21 getKeepFolderAttribute(保管フォルダ情報の取得)

記述形式

listConfig.getKeepFolderAttribute(保管フォルダ情報の番号)

機能

保管フォルダ情報を取得します。


パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

com.fujitsu.systemwalker.listworks.gateway.command.KeepFolderAttribute型の保管フォルダ情報


使用例

0番の保管フォルダ情報を取得します。

  listConfig.getKeepFolderAttribute(0);

3.2.3.22 getKeepFolderInfoNo(保管フォルダ情報の番号の取得)

記述形式

listConfig.getKeepFolderInfoNo(保管フォルダの論理パス,大小文字の区別)

機能

保管フォルダ情報の番号を取得します。


パラメタの説明

保管フォルダの論理パス

保管フォルダの論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。

例)Windows版の場合
    保管フォルダが「営業部」の場合
      C:\営業部
   Solaris版/Linux版の場合
    保管フォルダが「eigyo」の場合
      /eigyo
大小文字の区別

大小文字を区別するかどうかをboolean型で指定します。

  true:区別しない
  false:区別する

必ず指定します。


復帰値

使用例

Windows版の場合

保管フォルダの論理パスが「C:\営業」の保管フォルダ情報の番号を、大小文字の区別をしないで取得します。

  String strPath = new String("C:\\営業");
  listConfig.getKeepFolderInfoNo(strPath.getBytes("MS932"),true);
Solaris版/Linux版の場合

保管フォルダの論理パスが「/eigyo」の保管フォルダ情報の番号を、大小文字の区別をしないで取得します。

  String strPath = new String("/eigyo");
  listConfig.getKeepFolderInfoNo(strPath.getBytes("MS932"),true);

3.2.3.23 getKeepSheetAttribute(保管フォルダ内帳票情報の取得)

記述形式

listConfig.getKeepSheetAttribute(保管フォルダ内帳票情報番号)

機能

保管フォルダ内帳票情報を取得します。


パラメタの説明

保管フォルダ内帳票情報番号

保管フォルダ内帳票情報番号をint型で指定します。
必ず指定します。


復帰値

com.fujitsu.systemwalker.listworks.common.info.KeepSheetAttribute型の保管フォルダ内帳票情報


使用例

保管フォルダ内の0番の帳票情報を取得します。

  listConfig.getKeepSheetAttribute(0);

3.2.3.24 getKeepSheetInfoNo(保管フォルダ内帳票の番号の取得)

記述形式

listConfig.getKeepSheetInfoNo(保管フォルダ内帳票のファイル名,大小文字の区別)

機能

保管フォルダ内帳票の番号を取得します。


パラメタの説明

保管フォルダ内帳票のファイル名

保管フォルダ内帳票のファイル名をシフトJIS文字列のbyte型配列で指定します。
必ず指定します。

大小文字の区別

大小文字を区別するかどうかをboolean型で指定します。

  true:区別しない
  false:区別する

必ず指定します。


復帰値

int型の保管フォルダ内帳票の番号


使用例

保管フォルダ内のファイル名「ABC」の帳票番号を、大小文字の区別をしないで取得します。

  String strFile = new String("ABC.spl");
  listConfig.getKeepSheetInfoNo(strFile.getBytes("MS932"),true);

3.2.3.25 getNextKeepFolderInfoNo(次に存在する同一階層、それがない場合は親と同一階層で次に存在する保管フォルダ情報の番号の取得)

記述形式

listConfig.getNextKeepFolderInfoNo(保管フォルダ情報の番号)

機能

次に存在する同一階層、それがない場合は親と同一階層で、次に存在する保管フォルダの保管フォルダ情報の番号を取得します。

パラメタの説明

保管フォルダ情報の番号

保管フォルダ情報の番号をint型で指定します。
必ず指定します。


復帰値

使用例

1番のフォルダの次(同一階層、親階層)の保管フォルダ情報の番号を取得します。

  listConfig.getNextKeepFolderInfoNo(1);

注意

このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。


3.2.3.26 getListPrintPropertiesName(ListPrint.propertiesのファイル名を取得)

記述形式

listConfig.getListPrintPropertiesName()

機能

ListPrint.propertiesのファイル名を取得します。


パラメタの説明

なし


復帰値

java.lang.String型のListPrint.propertiesのファイル名


使用例

ListPrint.propertiesのファイル名を取得します。

  listConfig.getListPrintPropertiesName();

3.2.3.27 getPollingPrintWatchTime(ポーリング印刷における帳票一覧の監視時間の取得)

記述形式

listConfig.getPollingPrintWatchTime()

機能

ポーリング印刷において、帳票一覧を監視する時間を取得します。


パラメタの説明

なし


復帰値

int型の、ポーリング印刷において帳票一覧を監視する時間(秒)


使用例

ポーリング印刷において、帳票一覧を監視する時間を取得します。

  listConfig.getPollingPrintWatchTime();

3.2.3.28 getRemoteAddr(処理を要求したクライアントのホストIPアドレスの取得)

記述形式

listConfig.getRemoteAddr()

機能

処理を要求したクライアントのIPアドレスを取得します。


パラメタの説明

なし


復帰値

java.lang.String型の処理を要求したクライアントのIPアドレス


使用例

処理を要求したクライアントのIPアドレスを取得します。

  listConfig.getRemoteAddr();

3.2.3.29 getRemoteHost(処理を要求したクライアントのホスト名、または処理を要求したクライアントのホストIPアドレスの取得)

記述形式

listConfig.getRemoteHost()

機能

処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレスを取得します。


パラメタの説明

なし


復帰値

java.lang.String型の、処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレス


使用例

処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレスを取得します。

  listConfig.getRemoteHost();

注意

WWWサーバがInterstage HTTP Serverの場合、getRemoteHost の復帰値が正しく取得されない場合があります。このような場合、getRemoteAddr を使用してクライアントのIPアドレスを取得するようにしてください。


3.2.3.30 getSeparatorMark(フォルダ区切りマークの取得)

記述形式

listConfig.getSeparatorMark()

機能

フォルダ区切りマークを取得します。


パラメタの説明

なし


復帰値

java.lang.String型のフォルダ区切りマーク

  Windows版の場合:\
  Solaris版/Linux版の場合:/

使用例

フォルダ区切りマークを取得します。

  listConfig.getSeparatorMark();

3.2.3.31 getServerAddr(リスト管理サーバIPアドレスの取得)

記述形式

listConfig.getServerAddr()

機能

接続しているリスト管理サーバのIPアドレスを取得します。


パラメタの説明

なし


復帰値

java.lang.String型の、接続しているリスト管理サーバのIPアドレス


使用例

接続しているリスト管理サーバのIPアドレスを取得します。

  listConfig.getServerAddr();

3.2.3.32 getServerName(リスト管理サーバ名の取得)

記述形式

listConfig.getServerName()

機能

接続しているリスト管理サーバ名を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の、接続しているリスト管理サーバ名


使用例

接続しているリスト管理サーバ名を取得します。

  listConfig.getServerName();

3.2.3.33 getServletURL(ListGatewayのURLを取得)

ポイント

互換

getServletURLメソッドは、ListWORKS、およびList Works V6.0L10/6.0から移行した場合に、プログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。


記述形式

listConfig.getServletURL()

機能

ListGateway(サーブレット)のURLを取得します。


パラメタの説明

なし


復帰値

使用例

ListGateway(サーブレット)のURLを取得します。

  listConfig.getServletURL();

3.2.3.34 getSession(セションの取得)

記述形式

listConfig.getSession()

機能

セションを取得します。


パラメタの説明

なし


復帰値

java.lang.String型のセション


使用例

セションを取得します。

  listConfig.getSession();

3.2.3.35 getSessionID(セションIDの取得)

記述形式

listConfig.getSessionID()

機能

セションIDを取得します。


パラメタの説明

なし


復帰値

java.lang.String型のセションID


使用例

セションIDを取得します。

  listConfig.getSessionID();

3.2.3.36 getSheetNo(選択した帳票の番号の取得)

記述形式

listConfig.getSheetNo()

機能

選択した帳票の番号を取得します。


パラメタの説明

なし


復帰値

使用例

選択した帳票の番号を取得します。

  listConfig.getSheetNo();

注意

取得した帳票の番号は、次の帳票を選択するまで有効です。


3.2.3.37 getSheetPath(帳票の論理パスの取得)

記述形式

listConfig.getSheetPath()

機能

帳票の論理パスを取得します。

  形式:Windows版の場合
          保管フォルダの論理パスが「C:\営業部」、帳票のファイル名が「ABC.spl」の場合
            C:\営業部\ABC.spl
        Solaris版/Linux版の場合
          保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合
            /eigyo/ABC.spl

パラメタの説明

なし


復帰値

com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、帳票の論理パスのリスト


使用例

帳票の論理パスを取得します。

  listConfig.getSheetPath();

3.2.3.38 getStartNo(帳票一覧の最初の番号の取得)

記述形式

listConfig.getStartNo()

機能

帳票一覧の最初の番号を取得します。


パラメタの説明

なし


復帰値

使用例

帳票一覧の最初の番号を取得します。

  listConfig.getStartNo();

3.2.3.39 getTotalFolderNo(保管フォルダの総数の取得)

記述形式

listConfig.getTotalFolderNo()

機能

保管フォルダの総数を取得します。


パラメタの説明

なし


復帰値

getkeepfolderコマンドで取得したint型の、保管フォルダの総数


使用例

保管フォルダの総数を取得します。

  listConfig.getTotalFolderNo();

3.2.3.40 getTotalSheetNo(帳票の総数の取得)

記述形式

listConfig.getTotalSheetNo()

機能

選択した保管フォルダ内の帳票の総数を取得します。


パラメタの説明

なし


復帰値

int型の、選択した保管フォルダ内の帳票の総数


使用例

選択した保管フォルダ内の帳票の総数を取得します。

  listConfig.getTotalSheetNo();

3.2.3.41 getUsePdfSheet(PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を使用するかどうかの取得)

記述形式

listConfig.getUsePdfSheet()

機能

リスト管理サーバに接続しているユーザが、PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を利用するかどうかを取得します。


パラメタの説明

なし


復帰値

true

アクセス権がある帳票を、PDF形式で表示/PDF形式に変換して保存できる

false

アクセス権がある帳票も、PDF形式で表示/PDF形式に変換して保存できない


使用例

リスト管理サーバに接続しているユーザが、PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を使用するかどうかを取得します。

  listConfig.getUsePdfSheet();

3.2.3.42 getUsePrintedSheet(ローカル印刷識別を利用するかどうかを取得)

記述形式

listConfig.getUsePrintedSheet()

機能

リスト管理サーバに接続しているユーザが、ローカル印刷識別を利用するかどうかを取得します。

Windows版およびSolaris版の機能です。


パラメタの説明

なし


復帰値

true

ローカル印刷識別を利用できる

false

ローカル印刷識別を利用できない


使用例

リスト管理サーバに接続しているユーザが、ローカル印刷識別を利用するかどうかを取得します。

  listConfig.getUserPrintedSheet();

3.2.3.43 getUserID(ユーザIDを取得)

記述形式

listConfig.getUserID()

機能

リスト管理サーバへ接続したユーザIDを取得します。


パラメタの説明

なし


復帰値

java.lang.String型のリスト管理サーバへ接続したユーザID


使用例

リスト管理サーバへ接続したユーザIDを取得します。

  listConfig.getUserID();

3.2.3.44 getViewNo(帳票一覧に表示できる最大帳票数の取得)

記述形式

listConfig.getViewNo()

機能

帳票一覧の画面に表示できる最大帳票数を取得します。

参考

このメソッドで取得できる最大帳票数は、帳票一覧の1ページ内に表示できる最大帳票数です。


パラメタの説明

なし


復帰値

int型の、帳票一覧に表示できる最大帳票数


使用例

帳票一覧に表示できる最大帳票数を取得します。

  listConfig.getViewNo();

3.2.3.45 getViewSheetNo(表示する帳票の数の取得)

記述形式

listConfig.getViewSheetNo()

機能

帳票一覧に表示する帳票の数を取得します。


パラメタの説明

なし


復帰値

int型の、帳票一覧に表示する帳票の数


使用例

帳票一覧に表示する帳票の数を取得します。

  listConfig.getViewSheetNo();

3.2.3.46 setFolderPath(保管フォルダの論理パスを設定)

記述形式

listConfig.setFolderPath(保管フォルダの論理パス)

機能

保管フォルダの論理パスを設定します。


パラメタの説明

保管フォルダの論理パス

保管フォルダの論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。

例)Windows版の場合
    保管フォルダが「営業部」の場合
      C:\営業部
   Solaris版/Linux版の場合
    保管フォルダが「eigyo」の場合
      /eigyo

復帰値

なし


使用例

Windows版の場合

保管フォルダの論理パス「C:\営業」を設定します。

  String strFolder = new String("C:\\営業");
  listConfig.setFolderPath(strFolder.getBytes("MS932"));
Solaris版/Linux版の場合

保管フォルダの論理パス「/eigyo」を設定します。

  String strFolder = new String("/eigyo");
  listConfig.setFolderPath(strFolder.getBytes("MS932"));

注意

保管フォルダの論理パスは、リスト管理サーバ上のパスを指定します。


3.2.3.47 setListPrintPropertiesName(ListPrint.propertiesのファイル名を設定)

記述形式

listConfig.setListPrintPropertiesName(ListPrint.propertiesのファイル名)

機能

ListPrint.propertiesのファイル名を設定します。


パラメタの説明

ListPrint.propertiesのファイル名

ListPrint.propertiesのファイル名をシフトJIS文字列で指定します。必ず指定します。


復帰値

true

存在するファイルの名前を指定しました。

false

存在しないファイルの名前を指定しました。


使用例

ListPrint.propertiesのファイル名「ListPrint2.properties」を設定します。

  listConfig.setListPrintPropertiesName("ListPrint2.properties");

3.2.3.48 setSheetPath(帳票の論理パスの設定)

記述形式

listConfig.setSheetPath(帳票の論理パス)

機能

帳票の論理パスを設定します。


パラメタの説明

帳票の論理パス

帳票の論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。

例)Windows版の場合
    保管フォルダの論理パスが「C:\営業部」、帳票のファイル名が「ABC.spl」の場合
      C:\営業部\ABC.spl
   Solaris版/Linux版の場合
    保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合
      /eigyo/ABC.spl

復帰値

true

帳票の論理パスを設定しました。

false

帳票の論理パスを設定できませんでした。


使用例

Windows版の場合

帳票の論理パス「C:\営業\ABC.spl」を設定します。

  String strPath = new String("C:\\営業\\ABC.spl");
  listConfig.setSheetPath(strPath.getBytes("MS932"));
Solaris版/Linux版

帳票の論理パス「/eigyo/ABC.spl」を設定します。

  String strPath = new String("/eigyo/ABC.spl");
  listConfig.setSheetPath(strPath.getBytes("MS932"));

注意

  • このメソッドで帳票の論理パスを設定する場合、それまでに設定されていた論理パスはクリアされます。複数の帳票の論理パスを設定する場合には、2番目以降はaddSheetPathメソッドを使用する必要があります。

  • 帳票の論理パスは、リスト管理サーバ上のパスを指定します。