ListConfigとは、List Works構成クラスのことです。
以下に、Javaクラス(ListConfig)のメソッドを示します。
メソッド | 機能 |
---|---|
addSheetPath | 帳票の論理パスの追加<ActiveXコントロール版固有> |
compareKeepCheckInfo | 帳票が選択中かどうかの判定 |
getActivePage | 現在表示している帳票のページ番号の取得<ActiveXコントロール版固有> |
getApplicationURL | Web連携機能のURLを取得 (注1) |
getBrosKeepFolderInfoNo | 次に存在する同一階層の保管フォルダ情報の番号取得 |
getByteSwap | バイトスワップフラグの取得 |
getChildKeepFolderInfoNo | 下位の保管フォルダ情報の番号取得 |
getClassFolderNoList | 階層のフォルダ番号リストの取得 |
getClassNameList | 階層のフォルダ名リストの取得 |
getConnectForm | 連結できる最大帳票数の取得 |
getConnectServer | リスト管理サーバ接続フラグの取得 |
getCurrentFolderAttribute | 現在選択している保管フォルダの情報の取得 |
getCurrentFolderNameList | 最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストの取得 |
getEndNo | 帳票一覧の最後の番号の取得 |
getFolderNo | 選択している保管フォルダ番号の取得 |
getGroupCount | 所属グループの種別番号の取得 |
getHitTotalSheetNo | 選択した保管フォルダ内の表示条件に該当する帳票の総数の取得 |
getKeepFolderAttribute | 保管フォルダ情報の取得 |
getKeepFolderInfoNo | 保管フォルダ情報の番号の取得 |
getKeepSheetAttribute | 保管フォルダ内帳票情報の取得 |
getKeepSheetInfoNo | 保管フォルダ内帳票の番号の取得 |
getNextKeepFolderInfoNo | 次に存在する同一階層、それがない場合は親と同一階層で、次に存在する保管フォルダ情報の番号の取得 |
getPollingPrintWatchTime | ポーリング印刷における帳票一覧の監視時間の取得<ActiveXコントロール版固有> |
getRemoteAddr | 処理を要求したクライアントのホストIPアドレスの取得 |
getRemoteHost | 処理を要求したクライアントのホスト名、または処理を要求したクライアントのホストIPアドレスの取得 |
getSeparatorMark | フォルダ区切りマークの取得 |
getServerAddr | リスト管理サーバIPアドレスの取得 |
getServerName | リスト管理サーバ名の取得 |
getServletURL | ListGatewayのURLを取得 (注1) |
getSession | セションの取得 |
getSessionID | セションIDの取得 |
getSheetNo | 選択した帳票の番号の取得 |
getSheetPath | 帳票の論理パスの取得<ActiveXコントロール版固有> |
getStartNo | 帳票一覧の最初の番号の取得 |
getTotalFolderNo | 保管フォルダの総数の取得 |
getTotalSheetNo | 帳票の総数の取得 |
getUsePdfSheet | PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を使用するかどうかの取得 |
getUserID | ユーザIDを取得 |
getViewNo | 帳票一覧に表示できる最大帳票数の取得 |
getViewSheetNo | 表示する帳票の数の取得 |
setFolderPath | 保管フォルダの論理パスを設定 |
setSheetPath | 帳票の論理パスの設定<ActiveXコントロール版固有> |
注1:Solaris版旧バージョンで使用していたプログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。
記述形式
listConfig.addSheetPath(帳票の論理パス)
機能
リスト管理サーバ上での帳票の論理パスを追加します。
パラメタの説明
帳票の論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。
例)保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合 /eigyo/ABC.spl
復帰値
帳票の論理パスを追加しました。
帳票の論理パスを追加できませんでした。
使用例
帳票の論理パス「/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"));
記述形式
listConfig.compareKeepCheckInfo(ファイル名)
機能
帳票が選択中(帳票一覧で、帳票のチェックボックスがチェックされた状態)かどうか判定します。
パラメタの説明
java.lang.String型で帳票のファイル名を指定します。
必ず指定します。
復帰値
選択中です。
選択中ではありません。
使用例
帳票が選択中かどうか判定します。
listConfig.compareKeepCheckInfo("ABC.spl");
記述形式
listConfig.getActivePage()
機能
現在表示している帳票のページ番号を取得します。
パラメタの説明
なし
復帰値
一覧からの印刷画面を表示している場合は、0
帳票を表示している場合は、long型の現在表示しているページのページ番号
使用例
現在表示している帳票のページ番号を取得します。
listConfig.getActivePage();
注意
このメソッドは、一覧からの印刷画面および、帳票を表示している場合のみ有効です。
キャッシュされていないページを表示した場合のみ有効です。
ポイント
互換
getApplicationURLメソッドは、Solaris版旧バージョンで使用していたプログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。
記述形式
listConfig.getApplicationURL()
機能
List WorksのWeb連携機能(Webアプリケーション)のURLを取得します。
パラメタの説明
なし
復帰値
java.lang.String型のList WorksのWeb連携機能(Webアプリケーション)のURL
(SSLを導入している場合には、「http」の部分を「https」に置き換えて指定してください。)
形式:http://【server name】/listworks
WWWサーバのURLを指定していない場合は、null
使用例
List WorksのWeb連携機能(Webアプリケーション)のURLを取得します。
listConfig.getApplicationURL();
記述形式
listConfig.getBrosKeepFolderInfoNo(保管フォルダ情報の番号)
機能
次に存在する同一階層の保管フォルダ情報の番号を取得します。
フォルダ情報番号「0」を指定すると、「6」が復帰します。
フォルダ情報番号「3」を指定すると、「5」が復帰します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
int型の保管フォルダ情報の番号
次に存在する同一階層のフォルダがない場合は、-1
使用例
0番の保管フォルダの次に存在する同一階層の保管フォルダ情報の番号を取得します。
listConfig.getBrosKeepFolderInfoNo(0);
記述形式
listConfig.getByteSwap()
機能
バイトスワップフラグを取得します。
パラメタの説明
なし
復帰値
バイトスワップフラグを取得しました。
バイトスワップフラグを取得できませんでした。
使用例
バイトスワップフラグを取得します。
listConfig.getByteSwap();
記述形式
listConfig.getChildKeepFolderInfoNo(保管フォルダ情報の番号)
機能
下位の保管フォルダ情報の番号を取得します。直下に保管フォルダが複数ある場合は、最初の保管フォルダ情報の番号を取得します。
フォルダ情報番号「0」を指定すると、「1」が復帰します。
フォルダ情報番号「1」を指定すると、「2」が復帰します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
int型の、下位の保管フォルダ情報の番号
下位の保管フォルダがない場合は、-1
すべての保管フォルダの一覧を取得していない場合は、-1
使用例
0番の保管フォルダにおける、下位の保管フォルダ情報の番号を取得します。
listConfig.getChildKeepFolderInfoNo(0);
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。
記述形式
listConfig.getClassFolderNoList(保管フォルダ情報の番号)
機能
最上位の保管フォルダから、指定した保管フォルダ番号までの階層のフォルダ番号リストを取得します。
フォルダ情報番号「4」を指定すると、フォルダ情報番号「0」、「3」、「4」のフォルダ番号リストを獲得します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、最上位の保管フォルダからの階層のフォルダ番号リスト
すべての保管フォルダの一覧を取得していない場合は、指定したフォルダのフォルダ番号
使用例
最上位の保管フォルダから10番目の保管フォルダまでの階層のフォルダ番号リストを取得します。
listConfig.getClassFolderNoList(10);
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。
記述形式
listConfig.getClassNameList(保管フォルダ情報の番号)
機能
最上位の保管フォルダから、指定した保管フォルダ番号までのフォルダ名リストを取得します。
フォルダ情報番号「4」を指定すると、フォルダ情報番号「0」、「3」、「4」のフォルダ名リストを獲得します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、最上位の保管フォルダからの階層のフォルダ名リスト
すべての保管フォルダの一覧を取得していない場合は、指定した保管フォルダのフォルダ名
使用例
最上位の保管フォルダから10番目の保管フォルダまでの階層のフォルダ名リストを取得します。
listConfig.getClassNameList(10);
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。
記述形式
listConfig.getConnectForm()
機能
連結表示できる最大帳票数を取得します。
パラメタの説明
なし
復帰値
int型の連結表示できる最大帳票数
使用例
連結表示できる最大帳票数を取得します。
listConfig.getConnectForm();
記述形式
listConfig.getConnectServer()
機能
リスト管理サーバに接続しているかどうかの判定を取得します。
パラメタの説明
なし
復帰値
接続しています。
接続していません。
使用例
リスト管理サーバ接続フラグを取得します。
listConfig.getConnectServer();
記述形式
listConfig.getCurrentFolderAttribute()
機能
現在選択している保管フォルダの情報を取得します。
パラメタの説明
なし
復帰値
com.fujitsu.systemwalker.listworks.gateway.command.KeepFolderAttribute型の保管フォルダ情報
getkeepfolderコマンドで、rangeパラメタに「2」、「3」または「4」を指定していない場合は、null
使用例
現在選択している保管フォルダの情報を取得します。
listConfig.getCurrentFolderAttribute();
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドのrangeパラメタに「2」、「3」または「4」を指定して実行した場合のみ有効です。
記述形式
listConfig.getCurrentFolderNameList()
機能
最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストを取得します。
パラメタの説明
なし
復帰値
com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リスト
getkeepfolderコマンドで、rangeパラメタに「2」、「3」または「4」を指定していない場合は、null
使用例
最上位の保管フォルダから現在選択している保管フォルダまでのフォルダ名リストを取得します。
listConfig.getCurrentFolderNameList();
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドのrangeパラメタに「2」、「3」または「4」を指定して実行した場合のみ有効です。
記述形式
listConfig.getEndNo()
機能
帳票一覧の最後の番号を取得します。
パラメタの説明
なし
復帰値
int型の、帳票一覧の最後の番号
保管フォルダに帳票がない場合は、-1
使用例
帳票一覧の最後の番号を取得します。
listConfig.getEndNo();
記述形式
listConfig.getFolderNo()
機能
選択している保管フォルダ番号を取得します。
パラメタの説明
なし
復帰値
int型の選択している保管フォルダ番号
使用例
選択している保管フォルダ番号を取得します。
listConfig.getFolderNo();
記述形式
listConfig.getGroupCount()
機能
リスト管理サーバに接続中のユーザが所属しているグループの種別番号を取得します。
パラメタの説明
なし
復帰値
int型の、所属しているグループの種別番号
一般ユーザ
管理者
使用例
所属しているグループの種別番号を取得します。
listConfig.getGroupCount();
記述形式
listConfig.getHitTotalSheetNo()
機能
選択した保管フォルダ内の表示条件に該当する帳票の総数を取得します。
パラメタの説明
なし
復帰値
int型の、選択した保管フォルダ内の表示条件に該当する帳票の総数
使用例
選択した保管フォルダ内の表示条件に該当する帳票の総数を取得します。
listConfig.getHitTotalSheetNo();
記述形式
listConfig.getKeepFolderAttribute(保管フォルダ情報の番号)
機能
保管フォルダ情報を取得します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
com.fujitsu.systemwalker.listworks.gateway.command.KeepFolderAttribute型の保管フォルダ情報
使用例
0番の保管フォルダ情報を取得します。
listConfig.getKeepFolderAttribute(0);
記述形式
listConfig.getKeepFolderInfoNo(保管フォルダの論理パス,大小文字の区別)
機能
保管フォルダ情報の番号を取得します。
パラメタの説明
保管フォルダの論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。
例)保管フォルダが「eigyo」の場合 /eigyo
大小文字を区別するかどうかをboolean型で指定します。
true:区別しない false:区別する
必ず指定します。
復帰値
int型の保管フォルダ情報の番号
指定した保管フォルダがWeb連携上に取得されていない場合は、-1
使用例
保管フォルダの論理パスが「/eigyo」の保管フォルダ情報の番号を、大小文字の区別をしないで取得します。
String strPath = new String("/eigyo"); listConfig.getKeepFolderInfoNo(strPath.getBytes("MS932"),true);
記述形式
listConfig.getKeepSheetAttribute(保管フォルダ内帳票情報番号)
機能
保管フォルダ内帳票情報を取得します。
パラメタの説明
保管フォルダ内帳票情報番号をint型で指定します。
必ず指定します。
復帰値
com.fujitsu.systemwalker.listworks.common.info.KeepSheetAttribute型の保管フォルダ内帳票情報
使用例
保管フォルダ内の0番の帳票情報を取得します。
listConfig.getKeepSheetAttribute(0);
記述形式
listConfig.getKeepSheetInfoNo(保管フォルダ内帳票のファイル名,大小文字の区別)
機能
保管フォルダ内帳票の番号を取得します。
パラメタの説明
保管フォルダ内帳票のファイル名をシフトJIS文字列のbyte型配列で指定します。
必ず指定します。
大小文字を区別するかどうかをboolean型で指定します。
true:区別しない false:区別する
必ず指定します。
復帰値
int型の保管フォルダ内帳票の番号
使用例
保管フォルダ内のファイル名「ABC」の帳票番号を、大小文字の区別をしないで取得します。
String strFile = new String("ABC.spl"); listConfig.getKeepSheetInfoNo(strFile.getBytes("MS932"),true);
記述形式
listConfig.getNextKeepFolderInfoNo(保管フォルダ情報の番号)
機能
次に存在する同一階層、それがない場合は親と同一階層で、次に存在する保管フォルダの保管フォルダ情報の番号を取得します。
フォルダ情報番号「1」を指定すると、「3」が復帰します。
フォルダ情報番号「5」を指定すると、「6」が復帰します。
フォルダ情報番号「6」を指定すると、次に存在する同一階層のフォルダも親と同一階層で次に存在する保管フォルダもないため、「-1」が復帰します。
パラメタの説明
保管フォルダ情報の番号をint型で指定します。
必ず指定します。
復帰値
int型の、次(同一階層、親階層)の保管フォルダ情報の番号
次に存在する同一階層のフォルダも親と同一階層で次に存在する保管フォルダもない場合は、-1
すべての保管フォルダ一覧を取得していない場合は、-1
使用例
1番のフォルダの次(同一階層、親階層)の保管フォルダ情報の番号を取得します。
listConfig.getNextKeepFolderInfoNo(1);
注意
このメソッドは、Httpリクエストのgetkeepfolder(保管フォルダの一覧の表示)コマンドを、すべての保管フォルダを指定して実行した場合のみ有効です。
記述形式
listConfig.getPollingPrintWatchTime()
機能
ポーリング印刷において、帳票一覧を監視する時間を取得します。
パラメタの説明
なし
復帰値
int型の、ポーリング印刷において帳票一覧を監視する時間(秒)
使用例
ポーリング印刷において、帳票一覧を監視する時間を取得します。
listConfig.getPollingPrintWatchTime();
記述形式
listConfig.getRemoteAddr()
機能
処理を要求したクライアントのIPアドレスを取得します。
パラメタの説明
なし
復帰値
java.lang.String型の処理を要求したクライアントのIPアドレス
使用例
処理を要求したクライアントのIPアドレスを取得します。
listConfig.getRemoteAddr();
記述形式
listConfig.getRemoteHost()
機能
処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレスを取得します。
パラメタの説明
なし
復帰値
java.lang.String型の、処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレス
使用例
処理を要求したクライアントのホスト名、または処理を要求したクライアントのIPアドレスを取得します。
listConfig.getRemoteHost();
記述形式
listConfig.getSeparatorMark()
機能
フォルダ区切りマークを取得します。
パラメタの説明
なし
復帰値
java.lang.String型のフォルダ区切りマーク : /
使用例
フォルダ区切りマークを取得します。
listConfig.getSeparatorMark();
記述形式
listConfig.getServerAddr()
機能
接続しているリスト管理サーバのIPアドレスを取得します。
パラメタの説明
なし
復帰値
java.lang.String型の、接続しているリスト管理サーバのIPアドレス
使用例
接続しているリスト管理サーバのIPアドレスを取得します。
listConfig.getServerAddr();
記述形式
listConfig.getServerName()
機能
接続しているリスト管理サーバ名を取得します。
パラメタの説明
なし
復帰値
java.lang.String型の、接続しているリスト管理サーバ名
使用例
接続しているリスト管理サーバ名を取得します。
listConfig.getServerName();
ポイント
互換
getServletURLメソッドは、Solaris版旧バージョンで使用していたプログラムを変更しなくても継続して運用できるよう、互換のために用意されているメソッドです。
記述形式
listConfig.getServletURL()
機能
ListGateway(サーブレット)のURLを取得します。
パラメタの説明
なし
復帰値
java.lang.String型の、ListGateway(サーブレット)のURL
(SSLを導入している場合には、「http」の部分を「https」に置き換えて指定してください。)
形式:http://【server name】/listworks/servlet/ListGateway
WWWサーバのURLを指定していない場合は、null
使用例
ListGateway(サーブレット)のURLを取得します。
listConfig.getServletURL();
記述形式
listConfig.getSession()
機能
セションを取得します。
パラメタの説明
なし
復帰値
java.lang.String型のセション
使用例
セションを取得します。
listConfig.getSession();
記述形式
listConfig.getSessionID()
機能
セションIDを取得します。
パラメタの説明
なし
復帰値
java.lang.String型のセションID
使用例
セションIDを取得します。
listConfig.getSessionID();
記述形式
listConfig.getSheetNo()
機能
選択した帳票の番号を取得します。
パラメタの説明
なし
復帰値
int型の、選択した帳票の番号
一度も帳票を選択していない場合は、-1
使用例
選択した帳票の番号を取得します。
listConfig.getSheetNo();
注意
取得した帳票の番号は、次の帳票を選択するまで有効です。
記述形式
listConfig.getSheetPath()
機能
帳票の論理パスを取得します。
形式:保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合 /eigyo/ABC.spl
パラメタの説明
なし
復帰値
com.fujitsu.systemwalker.listworks.common.util.ObjectList型の、帳票の論理パスのリスト
使用例
帳票の論理パスを取得します。
listConfig.getSheetPath();
記述形式
listConfig.getStartNo()
機能
帳票一覧の最初の番号を取得します。
パラメタの説明
なし
復帰値
int型の、帳票一覧の最初の番号
保管フォルダに帳票がない場合は、-1
使用例
帳票一覧の最初の番号を取得します。
listConfig.getStartNo();
記述形式
listConfig.getTotalFolderNo()
機能
保管フォルダの総数を取得します。
パラメタの説明
なし
復帰値
getkeepfolderコマンドで取得したint型の、保管フォルダの総数
使用例
保管フォルダの総数を取得します。
listConfig.getTotalFolderNo();
記述形式
listConfig.getTotalSheetNo()
機能
選択した保管フォルダ内の帳票の総数を取得します。
パラメタの説明
なし
復帰値
int型の、選択した保管フォルダ内の帳票の総数
使用例
選択した保管フォルダ内の帳票の総数を取得します。
listConfig.getTotalSheetNo();
記述形式
listConfig.getUsePdfSheet()
機能
リスト管理サーバに接続しているユーザが、PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を利用するかどうかを取得します。
パラメタの説明
なし
復帰値
アクセス権がある帳票を、PDF形式で表示/PDF形式に変換して保存できる
アクセス権がある帳票も、PDF形式で表示/PDF形式に変換して保存できない
使用例
リスト管理サーバに接続しているユーザが、PDF形式での帳票の表示、および帳票をPDF形式に変換して保存する機能を使用するかどうかを取得します。
listConfig.getUsePdfSheet();
記述形式
listConfig.getUserID()
機能
リスト管理サーバへ接続したユーザIDを取得します。
パラメタの説明
なし
復帰値
java.lang.String型のリスト管理サーバへ接続したユーザID
使用例
リスト管理サーバへ接続したユーザIDを取得します。
listConfig.getUserID();
記述形式
listConfig.getViewNo()
機能
帳票一覧の画面に表示できる最大帳票数を取得します。
参考
このメソッドで取得できる最大帳票数は、帳票一覧の1ページ内に表示できる最大帳票数です。
パラメタの説明
なし
復帰値
int型の、帳票一覧に表示できる最大帳票数
使用例
帳票一覧に表示できる最大帳票数を取得します。
listConfig.getViewNo();
記述形式
listConfig.getViewSheetNo()
機能
帳票一覧に表示する帳票の数を取得します。
パラメタの説明
なし
復帰値
int型の、帳票一覧に表示する帳票の数
使用例
帳票一覧に表示する帳票の数を取得します。
listConfig.getViewSheetNo();
記述形式
listConfig.setFolderPath(保管フォルダの論理パス)
機能
保管フォルダの論理パスを設定します。
パラメタの説明
保管フォルダの論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。
例)保管フォルダが「eigyo」の場合 /eigyo
復帰値
なし
使用例
保管フォルダの論理パス「/eigyo」を設定します。
String strFolder = new String("/eigyo"); listConfig.setFolderPath(strFolder.getBytes("MS932"));
注意
保管フォルダの論理パスは、リスト管理サーバ上のパスを指定します。
記述形式
listConfig.setSheetPath(帳票の論理パス)
機能
帳票の論理パスを設定します。
パラメタの説明
帳票の論理パスをシフトJIS文字列のbyte型配列で指定します。
必ず指定します。
例)保管フォルダの論理パスが「/eigyo」、帳票のファイル名が「ABC.spl」の場合 /eigyo/ABC.spl
復帰値
帳票の論理パスを設定しました。
帳票の論理パスを設定できませんでした。
使用例
帳票の論理パス「/eigyo/ABC.spl」を設定します。
String strPath = new String("/eigyo/ABC.spl"); listConfig.setSheetPath(strPath.getBytes("MS932"));
注意
このメソッドで帳票の論理パスを設定する場合、それまでに設定されていた論理パスはクリアされます。複数の帳票の論理パスを設定する場合には、2番目以降はaddSheetPathメソッドを使用する必要があります。
帳票の論理パスは、リスト管理サーバ上のパスを指定します。