uap/webapps/gf/src/org/opengion/hayabusa/report/CSVPrintPointService.java_haishi

   1 /*
   2  * Copyright (c) 2009 The openGion Project.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  13  * either express or implied. See the License for the specific language
  14  * governing permissions and limitations under the License.
  15  */
  16 package org.opengion.hayabusa.report;
  17
  18 import org.opengion.hayabusa.db.DBTableModel;
  19
  20 /**
  21  * CSV発行用インターフェースです。
  22  *
  23  * @og.group 帳票システム
  24  *
  25  * @version  4.0
  26  * @author   Hiroki Nakamura
  27  * @since    JDK5.0,
  28  */
  29 public interface CSVPrintPointService {
  30
  31         /**
  32          * 帳票起動された要求番号をセットします。
  33          *
  34          * @param   ykno 要求NO
  35          */
  36         void setYkno( String ykno ) ;
  37
  38         /**
  39          * システムIDをセットします。
  40          *
  41          * @param   systemId システムID
  42          */
  43         void setSystemId( String systemId ) ;
  44
  45         /**
  46          * 実行方法をセットします。
  47          *
  48          * @param   fgrun 実行方法
  49          */
  50         void setFgrun( String fgrun ) ;
  51
  52         /**
  53          * 帳票デーモンが実行されているホスト名をセットします。
  54          *
  55          * @param   hostName ホスト名
  56          */
  57         void setHostName( String hostName ) ;
  58
  59         /**
  60          * プリンター名をセットします。
  61          *
  62          * @param   printerName プリンタ名
  63          */
  64         void setPrinterName( String printerName ) ;
  65
  66         /**
  67          * DBTableModel をセットします。
  68          *
  69          * @param       table   DBTableModelオブジェクト
  70          */
  71         void setTable( DBTableModel table ) ;
  72
  73         /**
  74          * DBTableModel をセットします。(ヘッダー）
  75          *
  76          * @param       table   DBTableModelオブジェクト
  77          */
  78         void setTableH( DBTableModel table ) ;
  79
  80         /**
  81          * DBTableModel をセットします（フッター）。
  82          *
  83          * @param       table   DBTableModelオブジェクト
  84          */
  85         void setTableF( DBTableModel table ) ;
  86
  87         /**
  88          * 起動するプログラムのディレクトリをセットします。
  89          *
  90          * @param       dir     PG起動ディレクトリ
  91          */
  92         void setPrgDir( String dir );
  93
  94         /**
  95          * 起動するプログラムをセットします。
  96          *
  97          * @param       file    PGファイル名
  98          */
  99         void setPrgFile( String file );
 100
 101         /**
 102          * ファイル出力時のディレクトリを指定します。
 103          *
 104          * @param       dir     出力ディレクトリ
 105          */
 106         void setOutDir( String dir );
 107
 108         /**
 109          * プリンタIDをセットします。
 110          *
 111          * @param       id      プリンタID
 112          */
 113         void setPrtId( String id );
 114
 115         /**
 116          * プリンターポート名をセットします。
 117          *
 118          * @param       port    ポート名
 119          */
 120         void setPortnm( String port ) ;
 121
 122         /**
 123          * 帳票IDをセットします。
 124          *
 125          * @param       id      帳票ID
 126          */
 127         void setListId( String id ) ;
 128
 129         /**
 130          * 帳票名をセットします。
 131          *
 132          * @param       name    帳票名
 133          */
 134         void setModelname( String name ) ;
 135
 136         /**
 137          * レイアウトファイルをセットします。
 138          *
 139          * @param       file    レイアウトファイル
 140          */
 141
 142         /**
 143          * グループIDをセットします。
 144          *
 145          * @og.rev 5.9.2.2 (2015/11/20)
 146          *
 147          * @param       id      グループID
 148          */
 149         void setGrpId( String id ) ;
 150
 151         /**
 152          * デーモングループをセットします。
 153          *
 154          * @og.rev 5.9.2.2 (2015/11/20)
 155          *
 156          * @param       name    デーモングループ
 157          */
 158         void setDmnGrp( String name ) ;
 159
 160         /**
 161          * オプション文字列をセットします。
 162          *
 163          * @og.rev 5.9.3.0 (2015/12/04)
 164          *
 165          * @param   option オプション文字列
 166          */
 167         void setOption( String option ) ;
 168
 169         /**
 170          * ページエンドカットフラグをセットします。
 171          *
 172          * @og.rev 5.9.3.0 (2015/12/04)
 173          *
 174          * @param       flg     ページエンドカットフラグ
 175          */
 176         void setFgcut( String flg ) ;
 177
 178         /**
 179          * 現在の印刷状況を返します。
 180          *
 181          *
 182          * @return      完成フラグ
 183          */
 184         String getFgkan();
 185
 186         /**
 187          * エラーメッセージを返します。
 188          *
 189          *
 190          * @return      エラーメッセージ
 191          */
 192         String getErrMsg();
 193
 194         /**
 195          * CSV発行処理を実行します。
 196          *
 197          *
 198          * @return      実行結果[true:正常/false:異常]
 199          */
 200         boolean execute() ;
 201 }