Interstage List Works for 大規模 V11.0.0 APIリファレンス

3.2 ListGateway

ListGateway (Javaサーブレットプログラム)は、HttpリクエストとJavaクラスを利用して、Webクライアントからの要求に応じてリスト管理サーバと通信し、結果をWebクライアントへ送信します。

• Httpリクエスト

  ListGatewayへの処理要求に使用します。

• Javaクラス

  Webクライアントに送信する結果を作成するための、必要な情報取得に使用します。
  Javaクラスには以下のクラスがあります。

    ListCommand
    ListConfig
    KeepFolderAttribute
    KeepSheetAttribute
    ObjectList
    HtmlConv

  
  

ListGatewayメソッド一覧表

以下に、ListGatewayメソッドを示します。

コマンド/メソッド		機能
Httpリクエスト	getjsp	JSPファイルの取得(セションに関係なし)
	getjspinsession	JSPファイルの取得(セションが有効な場合に限定する場合)
	getkeepfolder	保管フォルダ一覧の表示
	getkeeplist	帳票一覧の表示
	listbrowser	帳票の表示
	listprint	帳票の印刷
	login	リスト管理サーバに接続
	logout	リスト管理サーバから切断
	openframe	保管フォルダ/帳票一覧の表示準備
Javaクラス (ListCommand)	getFindTargetList	検索する対象範囲(抜き出し検索範囲)の一覧の取得準備
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	ローカル印刷識別を利用するかどうかの取得
	getUserID	ユーザIDを取得
	getViewNo	帳票一覧に表示できる最大帳票数の取得
	getViewSheetNo	表示する帳票の数の取得
	setFolderPath	保管フォルダの論理パスを設定
	setListPrintPropertiesName	ListPrint.propertiesのファイル名を設定
	setSheetPath	帳票の論理パスの設定
Javaクラス (KeepFolderAttribute)	getClassNo	保管フォルダの階層番号の取得
	getCreateDate	保管フォルダの作成日時の取得
	getName	保管フォルダ名の取得
	getNodeId	保管フォルダの識別子の取得
	getPath	保管フォルダの論理パスの取得
Javaクラス (KeepSheetAttribute)	getAccessCount	アクセス回数の取得
	getAutoDelete	[有効期限を過ぎたら削除対象にする]が設定されているかどうかの取得
	getComment	帳票のコメントの取得
	getCreateDate	帳票の作成日時の取得
	getCreatorName	帳票の作成者名の取得
	getDataSpaceType	印刷データの空白文字の扱いの取得
	getFileName	ファイル名の取得
	getFiling	ファイリングされているかどうかの取得
	getFlagInfo	フラグ情報の取得
	getIndexFind	抜き出し検索ができるかどうかの取得
	getItem	帳票に記入情報が記入されているかどうかの取得
	getMask	帳票のデータにマスク文字が存在するかどうかの取得
	getNForm	二次帳票が生成できるかどうかの取得
	getNodeId	帳票の識別子の取得
	getNote1	備考1の取得
	getNote2	備考2の取得
	getNote3	備考3の取得
	getNote4	備考4の取得
	getReferenceDate	最終参照日時の取得
	getRegistDate	登録日時の取得
	getSepSheet	結合帳票かどうかの取得
	getSepSheetCount	結合帳票を構成する帳票数の取得
	getSerialSheetNo	帳票番号の取得
	getTitle	帳票名の取得
	getTotalPage	ページ数の取得
	getValid	有効・無効フラグの取得
	getValidDate	登録有効期限の取得
	setValid	有効・無効フラグの設定
Javaクラス (ObjectList)	get	オブジェクトの取得
	getCount	オブジェクトの数の取得
Javaクラス (HtmlConv)	convVendorChar	Unicode文字列内のベンダ依存文字を変換
	toSjisArray	シフトJIS文字列をシフトJIS文字列のbyte型配列に変換
	toSjisString	Unicode文字列をシフトJIS文字列のStringに変換

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

サンプルプログラム

サンプルプログラムの種類と格納場所を以下に示します。ご使用の環境に合わせてカスタマイズすることができます。

なお、サンプルプログラム(JSPファイル)を編集した場合は、新しい編集内容を有効にする必要があります。

参照

サンプルプログラムの詳細な説明については、“付録D Web連携機能APIのサンプルプログラム”を参照してください。JSPファイルの編集内容を有効にする方法については、“セットアップガイド”を参照してください。

全体用のJSPサンプル

サンプルプログラムの種類

ユーザ認証をユーザのアプリケーションで行うサンプル

• ユーザID、パスワード、ホスト名、保管フォルダの論理パスを指定して帳票一覧を表示するサンプル

• ユーザID、パスワード、ホスト名、保管フォルダの論理パスを指定して帳票一覧を表示するサンプル(保管フォルダ一覧を非表示)

• ユーザID、パスワード、ホスト名、帳票の論理パスを指定して帳票を表示するサンプル

• ユーザID、パスワード、ホスト名、帳票の論理パスを指定して帳票を表示し、データ変換するサンプル

• ユーザID、パスワード、ホスト名、帳票の論理パスを指定して帳票を印刷するサンプル

• ユーザID、パスワード、ホスト名、帳票の論理パスを指定して帳票を印刷するサンプル(印刷画面を非表示)

ユーザ認証をList Worksで行うサンプル

• 保管フォルダの論理パスを指定して帳票一覧を表示するサンプル

• 保管フォルダの論理パスを指定して帳票一覧を表示するサンプル(保管フォルダ一覧を非表示)

• 帳票の論理パスを指定して帳票を表示するサンプル

• 帳票の論理パスを指定して帳票を表示し、データ変換するサンプル

• 帳票の論理パスを指定して帳票を印刷するサンプル

• 帳票の論理パスを指定して帳票を印刷するサンプル(印刷画面を非表示)

保管フォルダ一覧のサンプル

• すべての保管フォルダを、ツリーが閉じた状態で表示するサンプル

• すべての保管フォルダを、ツリーが開いた状態で表示するサンプル

帳票一覧のサンプル

• ユーザ名、パスワード、ホスト名、および帳票一覧に表示される帳票の表示条件を指定して、帳票一覧を表示するサンプル

タブレットで帳票を表示するサンプル

• タブレットから、帳票をPDF形式で表示するサンプル

  
  

格納場所

• Windows版の場合

  List Worksのインストール先フォルダ\web\app\jsp\sample\other

• Solaris版/Linux版の場合

  List Works Web連携のインストールディレクトリ/FJSVlw-gw/app/jsp/sample/other

  
  

ポーリング印刷用のJSPサンプル

サンプルプログラムの種類

• ポーリング印刷を自動的に起動するサンプル

• プリンタを指定してポーリング印刷を自動的に起動するサンプル

  
  

格納場所

• Windows版の場合

  List Worksのインストール先フォルダ\web\app\jsp\sample\pollingprint

• Solaris版/Linux版の場合

  List Works Web連携のインストールディレクトリ/FJSVlw-gw/app/jsp/sample/pollingprint

  
  

注意

• JavaスクリプトのWindowオブジェクトのopenメソッドを使用し複数のウィンドウを開いて、List Works(Webクライアント)を操作することはできません。

• JSPファイルは、シフトJISコードで記述されています。JSPファイルを編集する場合には、シフトJISコードで記述してください。