001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.hayabusa.report;
017
018import java.util.Map;
019
020import org.opengion.hayabusa.db.DBTableModel;
021
022/**
023 * CSV発行用インターフェースです。
024 *
025 * @og.group 帳票システム
026 *
027 * @version  4.0
028 * @author   Hiroki Nakamura
029 * @since    JDK5.0,
030 */
031public interface CSVPrintPointService {
032
033        /**
034         * 帳票起動された要求番号をセットします。
035         *
036         * @param   ykno 要求NO
037         */
038        void setYkno( String ykno ) ;
039
040        /**
041         * システムIDをセットします。
042         *
043         * @param   systemId システムID
044         */
045        void setSystemId( String systemId ) ;
046
047        /**
048         * 実行方法をセットします。
049         *
050         * @param   fgrun 実行方法
051         */
052        void setFgrun( String fgrun ) ;
053
054        /**
055         * 帳票デーモンが実行されているホスト名をセットします。
056         *
057         * @param   hostName ホスト名
058         */
059        void setHostName( String hostName ) ;
060
061        /**
062         * プリンター名をセットします。
063         *
064         * @param   printerName プリンタ名
065         */
066        void setPrinterName( String printerName ) ;
067
068        /**
069         * DBTableModel をセットします。
070         *
071         * @param       table   DBTableModelオブジェクト
072         */
073        void setTable( DBTableModel table ) ;
074        
075        /**
076         * DBTableModel をセットします。(ヘッダー)
077         *
078         * @param       table   DBTableModelオブジェクト
079         */
080        void setTableH( DBTableModel table ) ;
081        
082        /**
083         * DBTableModel をセットします。(フッター)
084         *
085         * @param       table   DBTableModelオブジェクト
086         */
087        void setTableF( DBTableModel table ) ;
088
089
090        /**
091         * 起動するプログラムのディレクトリをセットします。
092         *
093         * @param       dir     PG起動ディレクトリ
094         */
095        void setPrgDir( String dir );
096
097        /**
098         * 起動するプログラムをセットします。
099         *
100         * @param       file    PGファイル名
101         */
102        void setPrgFile( String file );
103
104        /**
105         * ファイル出力時のディレクトリを指定します
106         *
107         * @param       dir     出力ディレクトリ
108         */
109        void setOutDir( String dir );
110
111        /**
112         * プリンタIDをセットします。
113         *
114         * @param       id      プリンタID
115         */
116        void setPrtId( String id );
117
118        /**
119         * プリンターポート名をセットします。
120         *
121         * @param       port    ポート名
122         */
123        void setPortnm( String port ) ;
124
125        /**
126         * 帳票IDをセットします。
127         *
128         * @param       id      帳票ID
129         */
130        void setListId( String id ) ;
131        
132        /**
133         * 帳票名をセットします。
134         *
135         * @param       name    帳票名
136         */
137        void setModelname( String name ) ;
138
139        /**
140         * レイアウトファイルをセットします。
141         *
142         * @param       file    レイアウトファイル
143         */
144//      void setLayoutFile( String file );
145        
146        /**
147         * グループIDをセットします。
148         * 
149         * @og.rev 5.9.2.2 (2015/11/20)
150         * 
151         * @param       id      グループID
152         */
153        void setGrpId( String id ) ;
154        
155        /**
156         * デーモングループをセットします。
157         * 
158         * @og.rev 5.9.2.2 (2015/11/20)
159         * 
160         * @param       name    デーモングループ
161         */
162        void setDmnGrp( String name ) ;
163        
164        /**
165         * オプション文字列をセットします。
166         * 
167         * @og.rev 5.9.3.0 (2015/12/04)
168         * 
169         * @param       option  
170         */
171        void setOption( String option ) ;
172        
173        /**
174         * ページエンドカットフラグをセットします。
175         * 
176         * @og.rev 5.9.3.0 (2015/12/04)
177         * 
178         * @param       option  
179         */
180        void setFgcut( String flg ) ;
181
182        /**
183         * 現在の印刷状況を返します
184         *
185         *
186         * @return      完成フラグ
187         */
188        String getFgkan();
189
190        /**
191         * エラーメッセージを返します
192         *
193         *
194         * @return      エラーメッセージ
195         */
196        String getErrMsg();
197
198        /**
199         * CSV発行処理を実行します。
200         *
201         *
202         * @return      実行結果[true:正常/false:異常]
203         */
204        boolean execute() ;
205}