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