001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.jsf2.metafacades;
006
007import org.andromda.metafacades.uml.FrontEndExceptionHandler;
008
009/**
010 * TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFExceptionHandler
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface JSFExceptionHandler
015    extends FrontEndExceptionHandler
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isJSFExceptionHandlerMetaType();
023
024    /**
025     * The key to use with this handler's message resource bundle that will retrieve the error
026     * message template for this exception.
027     * @return String
028     */
029    public String getExceptionKey();
030
031    /**
032     * The module-relative URI to the resource that will complete the request/response if this
033     * exception occurs.
034     * @return String
035     */
036    public String getExceptionPath();
037
038    /**
039     * Fully qualified Java class name of the exception type to register with this handler.
040     * @return String
041     */
042    public String getExceptionType();
043
044    /**
045     * TODO: Model Documentation for
046     * org.andromda.cartridges.jsf2.metafacades.JSFExceptionHandler.messageKey
047     * @return String
048     */
049    public String getMessageKey();
050}