/*
 * This software is distributed under following license based on modified BSD
 * style license.
 * ----------------------------------------------------------------------
 * 
 * Copyright 2009 The Nimbus2 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 Nimbus2 Project.
 */
package jp.ossc.nimbus.service.aop.interceptor;

import java.util.Locale;

import jp.ossc.nimbus.core.*;

/**
 * {@link ExceptionThrowInterceptorService}のMBeanインタフェース<p>
 * 
 * @author M.Takata
 * @see ExceptionThrowInterceptorService
 */
public interface ExceptionThrowInterceptorServiceMBean extends ServiceBaseMBean{
    
    /**
     * 例外をthrowする/しないを設定する。<p>
     *
     * @param enabled throwする場合は、true
     */
    public void setEnabled(boolean enabled);
    
    /**
     * 例外をthrowする/しないを判定する。<p>
     *
     * @return trueの場合、有効
     */
    public boolean isEnabled();
    
    /**
     * throwする例外を取得する。<p>
     * 
     * @return throwする例外
     */
    public Throwable getThrowable();
    
    /**
     * throwする例外クラスを設定する。<p>
     * 
     * @param clazz throwする例外クラス
     */
    public void setThrowableClass(Class<?> clazz);
    
    /**
     * throwする例外クラスを取得する。<p>
     * 
     * @return throwする例外クラス
     */
    public Class<?> getThrowableClass();
    
    /**
     * throwする例外のメッセージを設定する。<p>
     * 
     * @param message メッセージ
     */
    public void setThrowableMessage(String message);
    
    /**
     * throwする例外のメッセージを取得する。<p>
     * 
     * @return メッセージ
     */
    public String getThrowableMessage();
    
    /**
     * throwする例外のメッセージキーを設定する。<p>
     * 設定されたメッセージキーで、このサービスに設定された{@link jp.ossc.nimbus.service.message.MessageRecordFactory MessageRecordFactory}からメッセージを取得する。<br>
     * 
     * @param key メッセージキー
     */
    public void setThrowableMessageKey(String key);
    
    /**
     * throwする例外のメッセージキーを取得する。<p>
     * 
     * @return メッセージキー
     */
    public String getThrowableMessageKey();
    
    /**
     * throwする例外のメッセージロケールを設定する。<p>
     * 設定されたメッセージロケールで、このサービスに設定された{@link jp.ossc.nimbus.service.message.MessageRecordFactory MessageRecordFactory}からメッセージを取得する。<br>
     * 
     * @param locale メッセージロケール
     */
    public void setThrowableMessageLocale(Locale locale);
    
    /**
     * throwする例外のメッセージロケールを取得する。<p>
     * 
     * @return メッセージロケール
     */
    public Locale getThrowableMessageLocale();
    
    /**
     * throwする例外のメッセージ埋め込みパラメータを設定する。<p>
     * 設定されたメッセージ埋め込みパラメータで、このサービスに設定された{@link jp.ossc.nimbus.service.message.MessageRecordFactory MessageRecordFactory}からメッセージを取得する。<br>
     * 
     * @param args メッセージ埋め込みパラメータ
     */
    public void setThrowableMessageArgs(Object[] args);
    
    /**
     * throwする例外のメッセージ埋め込みパラメータを取得する。<p>
     * 
     * @return メッセージ埋め込みパラメータ
     */
    public Object[] getThrowableMessageArgs();
}
