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     */
016    package org.opengion.fukurou.transfer;
017    
018    import org.opengion.fukurou.db.Transaction;
019    import org.opengion.fukurou.util.ApplicationInfo;
020    
021    /**
022     * 莨晞?隕∵ｱゅ↓蟇ｾ縺吶ｋ縺ｮ隱ｭ蜿匁婿豕輔ｒ螳夂ｾｩ縺吶ｋ繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ縺ｧ縺吶?
023     *
024     * 蜷?ｮ溯｣?け繝ｩ繧ｹ縺ｧ縺ｯ縲∬ｪｭ蜿門?逅?@link #read(TransferConfig, Transaction)}
025     * 縲∝ｮ御ｺ??逅?@link #complete(TransferConfig, Transaction)}縲√お繝ｩ繝ｼ蜃ｦ逅?@link #error(TransferConfig, ApplicationInfo)}繧貞ｮ溯｣?☆繧句ｿ?ｦ√′縺ゅｊ縺ｾ縺吶?
026     * 繧ｵ繝悶け繝ｩ繧ｹ蜀?Κ縺ｧ縲．B髢｢騾｣縺ｮ蜃ｦ逅?ｒ陦後≧蝣ｴ蜷医?縲∝ｼ墓焚縺ｮTransaction繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ蛻ｩ逕ｨ縺励※荳九＆縺??
027     * 縺ｾ縺溘?謗･邯壹↓蟇ｾ縺吶ｋCommit/Rollback縺ｯ縲∝他縺ｳ蜃ｺ縺怜?縺ｧ陦後＞縺ｾ縺吶?縺ｧ縲∝ｮ溯｡悟?逅??荳ｭ縺ｧ縺ｯ陦後ｏ縺ｪ縺?〒荳九＆縺??
028     *
029     * 縺ｾ縺溘?HTTP邨檎罰縺ｧ縺ｮ螳溯｡後↑縺ｩ縺ｧ縲∬ｪｭ蜿門?逅?→縺昴?蠕後?螳御ｺ?繧ｨ繝ｩ繝ｼ蜃ｦ逅?〒繧ｪ繝悶ず繧ｧ繧ｯ繝医′蜷御ｸ??縺ｪ縺??蜷医↓縲?
030     * 螟夜Κ縺九ｉ隱ｭ蜿悶く繝ｼ縺ｮ蜿門ｾ怜所縺ｳ險ｭ螳壹ｒ陦後≧縺薙→縺後〒縺阪∪縺吶?
031     * 蜈ｷ菴鍋噪縺ｫ縺ｯ縲＋@link #read(TransferConfig, Transaction)}繧貞ｮ溯｡悟ｾ後?{@link #getKeys()}繧貞他縺ｳ蜃ｺ縺励☆繧九％縺ｨ縺ｧ
032     * 邨ゆｺ??逅?〒蜃ｦ逅?ｯｾ雎｡縺ｨ縺ｪ繧九く繝ｼ諠??繧貞叙蠕励☆繧九％縺ｨ縺後〒縺阪∪縺吶?
033     * 縺薙?繧ｭ繝ｼ諠??繧剃ｿ晄戟縺励?{@link #setKeys(String[])}縺ｧ蛻･繧ｪ繝悶ず繧ｧ繧ｯ繝医↓蟇ｾ縺励※繧ｭ繝ｼ繧定ｨｭ螳壹☆繧九％縺ｨ縺ｧ縲?
034     * 螳御ｺ??逅?@link #complete(TransferConfig, Transaction)}縲√お繝ｩ繝ｼ蜃ｦ逅?@link #error(TransferConfig, ApplicationInfo)}
035     * 繧貞他縺ｳ蜃ｺ縺励☆繧九％縺ｨ縺後〒縺阪∪縺吶?
036     *
037     * @og.group 莨晞?繧ｷ繧ｹ繝?Β
038     *
039     * @version  5.0
040     * @author   Hiroki.Nakamura
041     * @since    JDK1.6
042     */
043    public interface TransferRead {
044    
045            /**
046             * 隱ｭ蜿門?逅?ｒ螳溯｡後＠縲∫ｵ先棡繧偵ユ繧ｭ繧ｹ繝医ョ繝ｼ繧ｿ縺ｮ驟榊?縺ｨ縺励※霑斐＠縺ｾ縺吶?
047             *
048             * @param config 莨晞?險ｭ螳壹が繝悶ず繧ｧ繧ｯ繝?
049             * @param tran 繝医Λ繝ｳ繧ｶ繧ｯ繧ｷ繝ｧ繝ｳ繧ｪ繝悶ず繧ｧ繧ｯ繝?
050             *
051             * @return 隱ｭ縺ｿ蜿悶ｊ縺励◆繝??繧ｿ(驟榊?)
052             */
053            public String[] read( final TransferConfig config, final Transaction tran );
054    
055            /**
056             * 譖ｴ譁ｰ繧ｭ繝ｼ(驟榊?)繧定ｿ斐＠縺ｾ縺吶?
057             *
058             * @return 譖ｴ譁ｰ繧ｭ繝ｼ(驟榊?)
059             */
060            public String[] getKeys();
061    
062            /**
063             * 譖ｴ譁ｰ繧ｭ繝ｼ(驟榊?)繧偵そ繝?ヨ縺励∪縺吶?
064             *
065             * @param keys 譖ｴ譁ｰ繧ｭ繝ｼ(驟榊?)
066             */
067            public void setKeys( final String[] keys );
068    
069            /**
070             * 螳御ｺ??逅?ｒ螳溯｡後＠縺ｾ縺吶?
071             * 縺薙?蜃ｦ逅??螳溯｡梧婿豕輔〒螳夂ｾｩ縺輔ｌ縺溷ｮ溯｡悟?逅?′豁｣蟶ｸ邨ゆｺ?＠縺溷?蜷医↓蜻ｼ縺ｳ蜃ｺ縺励＆繧後∪縺吶?
072             * 譖ｴ譁ｰ蟇ｾ雎｡縺ｮ繧ｭ繝ｼ縺ｫ縺､縺?※縺ｯ縲＋@link #setKeys(String[])}縺ｧ螟夜Κ縺九ｉ繧ｻ繝?ヨ縺吶ｋ縺薙→繧ゅ〒縺阪∪縺吶?
073             *
074             * @param config 莨晞?險ｭ螳壹が繝悶ず繧ｧ繧ｯ繝?
075             * @param tran 繝医Λ繝ｳ繧ｶ繧ｯ繧ｷ繝ｧ繝ｳ繧ｪ繝悶ず繧ｧ繧ｯ繝?
076             */
077            public void complete( final TransferConfig config, final Transaction tran );
078    
079            /**
080             * 繧ｨ繝ｩ繝ｼ蜃ｦ逅?ｒ螳溯｡後＠縺ｾ縺吶?
081             * 縺薙?蜃ｦ逅??螳溯｡梧婿豕輔〒螳夂ｾｩ縺輔ｌ縺溷ｮ溯｡悟?逅?′莉･荳顔ｵゆｺ?＠縺溷?蜷医↓蜻ｼ縺ｳ蜃ｺ縺励＆繧後∪縺吶?
082             * 譖ｴ譁ｰ蟇ｾ雎｡縺ｮ繧ｭ繝ｼ縺ｫ縺､縺?※縺ｯ縲＋@link #setKeys(String[])}縺ｧ螟夜Κ縺九ｉ繧ｻ繝?ヨ縺吶ｋ縺薙→繧ゅ〒縺阪∪縺吶?
083             *
084             * @param config 莨晞?險ｭ螳壹が繝悶ず繧ｧ繧ｯ繝?
085             * @param appInfo DB謗･邯壽ュ蝣ｱ
086             */
087            public void error( final TransferConfig config, final ApplicationInfo appInfo );
088    }