/*
 * This software is distributed under following license based on modified BSD
 * style license.
 * ----------------------------------------------------------------------
 * 
 * Copyright 2003 The Nimbus Project. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE NIMBUS PROJECT ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 * NO EVENT SHALL THE NIMBUS PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the Nimbus Project.
 */
package jp.ossc.nimbus.service.beanflow;

import jp.ossc.nimbus.core.ServiceBaseMBean;
import jp.ossc.nimbus.core.ServiceName;

/**
 * {@link DefaultBeanFlowFactoryService}のMBeanインタフェース。<p>
 * 
 * @author M.Takata
 * @see DefaultBeanFlowFactoryService
 */
public interface DefaultBeanFlowFactoryServiceMBean extends ServiceBaseMBean{
    
    /**
     * BeanFlow定義ファイルの格納場所となるディレクトリを設定する。<p>
     * 絶対パス、実行ディレクトリからの相対パス、サービス定義ファイルからの相対パスのいずれかを指定する。<br>
     *
     * @param dirs ディレクトリのパス配列
     */
    public void setFlowDirs(String[] dirs);
    
    /**
     * BeanFlow定義ファイルの格納場所となるディレクトリを取得する。<p>
     *
     * @return ディレクトリのパス配列
     */
    public String[] getFlowDirs();
    
    /**
     * BeanFlow定義ファイルのパスを設定する。<p>
     * 絶対パス、実行ディレクトリからの相対パス、クラスパス上のリソースパス、サービス定義ファイルからの相対パスのいずれかを指定する。<br>
     *
     * @param dirs BeanFlow定義ファイルのパス配列
     */
    public void setFlowPaths(String[] paths);
    
    /**
     * BeanFlow定義ファイルのパスを取得する。<p>
     *
     * @return BeanFlow定義ファイルのパス配列
     */
    public String[] getFlowPaths();
    
    /**
     * BeanFlow定義ファイルをパースするjavax.xml.parsers.DocumentBuilderFactoryのクラス名を設定する。<p>
     * 指定しない場合は、DocumentBuilderFactory.newInstance()でDocumentBuilderFactoryを生成する。<br>
     *
     * @param name DocumentBuilderFactoryのクラス名
     */
    public void setDocumentBuilderFactoryClassName(String name);
    
    /**
     * BeanFlow定義ファイルをパースするjavax.xml.parsers.DocumentBuilderFactoryのクラス名を取得する。<p>
     *
     * @return DocumentBuilderFactoryのクラス名
     */
    public String getDocumentBuilderFactoryClassName();
    
    /**
     * BeanFlow定義ファイルを検証するかどうかを設定する。<p>
     * デフォルトは、falseで検証しない。<br>
     * 
     * @param validate 検証する場合、true
     */
    public void setValidate(boolean validate);
    
    /**
     * BeanFlow定義ファイルを検証するかどうかを判定する。<p>
     * 
     * @return trueの場合、検証する
     */
    public boolean isValidate();
    
    public void setContextServiceName(ServiceName name);
    public ServiceName getContextServiceName();
    
    public void setInterceptorChainFactoryServiceName(ServiceName name);
    public ServiceName getInterceptorChainFactoryServiceName();
    
    public void setJournalServiceName(ServiceName name);
    public ServiceName getJournalServiceName();
    
    public void setEditorFinderServiceName(ServiceName name);
    public ServiceName getEditorFinderServiceName();
    
    /**
     * expression要素の評価に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を設定する。<p>
     *
     * @param name Interpreterサービスのサービス名
     */
    public void setExpressionInterpreterServiceName(ServiceName name);
    
    /**
     * expression要素の評価に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を取得する。<p>
     *
     * @return Interpreterサービスのサービス名
     */
    public ServiceName getExpressionInterpreterServiceName();
    
    /**
     * if要素や、case要素のtest属性の判定に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を設定する。<p>
     *
     * @param name Interpreterサービスのサービス名
     */
    public void setTestInterpreterServiceName(ServiceName name);
    
    /**
     * if要素や、case要素のtest属性の判定に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を取得する。<p>
     *
     * @return Interpreterサービスのサービス名
     */
    public ServiceName getTestInterpreterServiceName();
    
    /**
     * interperter要素の実行に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を設定する。<p>
     *
     * @param name Interpreterサービスのサービス名
     */
    public void setInterpreterServiceName(ServiceName name);
    
    /**
     * interperter要素の実行に使用する{@link jp.ossc.nimbus.service.interpreter.Interpreter Interpreter}サービスのサービス名を取得する。<p>
     *
     * @return Interpreterサービスのサービス名
     */
    public ServiceName getInterpreterServiceName();
    
    public void setTransactionManagerFactoryServiceName(ServiceName name);
    public ServiceName getTransactionManagerFactoryServiceName();
    
    public void setAsynchExecuteQueueHandlerContainerServiceName(ServiceName name);
    public ServiceName getAsynchExecuteQueueHandlerContainerServiceName();
    
    /**
     * 非同期実行のハンドリング中にエラーが発生した場合に出力するログのメッセージIDを設定する。<p>
     * デフォルトは、nullで、ログを出力しない。<br>
     *
     * @param id ログのメッセージID
     */
    public void setAsynchExecuteErrorLogMessageId(String id);
    
    /**
     * 非同期実行のハンドリング中にエラーが発生した場合に出力するログのメッセージIDを取得する。<p>
     * 
     * @return ログのメッセージID
     */
    public String getAsynchExecuteErrorLogMessageId();
    
    /**
     * 非同期実行のハンドリング中にエラーが発生し、規定のリトライ回数を越えた場合に出力するログのメッセージIDを設定する。<p>
     * デフォルトは、nullで、ログを出力しない。<br>
     *
     * @param id ログのメッセージID
     */
    public void setAsynchExecuteRetryOverErrorLogMessageId(String id);
    
    /**
     * 非同期実行のハンドリング中にエラーが発生し、規定のリトライ回数を越えた場合に出力するログのメッセージIDを取得する。<p>
     * 
     * @return ログのメッセージID
     */
    public String getAsynchExecuteRetryOverErrorLogMessageId();
    
    /**
     * 再読み込みする。<p>
     *
     * @exception Exception 再読み込みに失敗した場合
     */
    public void reload() throws Exception;
}
