    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 org.opengion.hayabusa.db.DBTableModel;
    019
    020/**
    021 * CSV発行用インターフェースです。
    022 *
    023 * @og.group 帳票システム
    024 *
    025 * @version  4.0
    026 * @author   Hiroki Nakamura
    027 * @since    JDK5.0,
    028 */
    029public interface CSVPrintPointService {
    030
    031        /**
    032         * 帳票起動された要求番号をセットします。
    033         *
    034         * @param   ykno 要求NO
    035         */
    036        void setYkno( String ykno ) ;
    037
    038        /**
    039         * システムIDをセットします。
    040         *
    041         * @param   systemId システムID
    042         */
    043        void setSystemId( String systemId ) ;
    044
    045        /**
    046         * 実行方法をセットします。
    047         *
    048         * @param   fgrun 実行方法
    049         */
    050        void setFgrun( String fgrun ) ;
    051
    052        /**
    053         * 帳票デーモンが実行されているホスト名をセットします。
    054         *
    055         * @param   hostName ホスト名
    056         */
    057        void setHostName( String hostName ) ;
    058
    059        /**
    060         * プリンター名をセットします。
    061         *
    062         * @param   printerName プリンタ名
    063         */
    064        void setPrinterName( String printerName ) ;
    065
    066        /**
    067         * DBTableModel をセットします。
    068         *
    069         * @param       table   DBTableModelオブジェクト
    070         */
    071        void setTable( DBTableModel table ) ;
    072
    073        /**
    074         * DBTableModel をセットします。(ヘッダー）
    075         *
    076         * @param       table   DBTableModelオブジェクト
    077         */
    078        void setTableH( DBTableModel table ) ;
    079
    080        /**
    081         * DBTableModel をセットします（フッター）。
    082         *
    083         * @param       table   DBTableModelオブジェクト
    084         */
    085        void setTableF( DBTableModel table ) ;
    086
    087        /**
    088         * 起動するプログラムのディレクトリをセットします。
    089         *
    090         * @param       dir     PG起動ディレクトリ
    091         */
    092        void setPrgDir( String dir );
    093
    094        /**
    095         * 起動するプログラムをセットします。
    096         *
    097         * @param       file    PGファイル名
    098         */
    099        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}