001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.ejb3.metafacades;
006
007import org.andromda.metafacades.uml.ManageableEntity;
008
009/**
010 * TODO: Model Documentation for org.andromda.cartridges.ejb3.metafacades.EJB3ManageableEntityFacade
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface EJB3ManageableEntityFacade
015    extends EJB3EntityFacade, ManageableEntity
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isEJB3ManageableEntityFacadeMetaType();
023
024    /**
025     * Returns the fully qualified manageable service base class name that contains the
026     * implementation.
027     * @return String
028     */
029    public String getFullyQualifiedManageableServiceBaseName();
030
031    /**
032     * Returns the fully qualified name of the application create exception.
033     * @return String
034     */
035    public String getFullyQualifiedManageableServiceCreateExceptionName();
036
037    /**
038     * Returns the fully qualified delete application exception name.
039     * @return String
040     */
041    public String getFullyQualifiedManageableServiceDeleteExceptionName();
042
043    /**
044     * Returns the fully qualified name of the application read exception.
045     * @return String
046     */
047    public String getFullyQualifiedManageableServiceReadExceptionName();
048
049    /**
050     * Returns the fully qualified update application exception name.
051     * @return String
052     */
053    public String getFullyQualifiedManageableServiceUpdateExceptionName();
054
055    /**
056     * Returns the JNDI name prefix for this menageable session bean.  This is set using the
057     * jndiNamePrefix namespace property and is commonly the ear file name excluding the extension
058     * for the EJB3 cartridge.  The JNDI name prefix is applied like so:
059     * jndiPrefix/EJBName/Remote
060     * @return String
061     */
062    public String getJndiNamePrefix();
063
064    /**
065     * Returns the comma separated list of roles which are used to secure manageable service beans.
066     * @return String
067     */
068    public String getManageableRolesAllowed();
069
070    /**
071     * Returns the manageable service base class fully qualified path used to set the template
072     * generated file.
073     * @return String
074     */
075    public String getManageableServiceBaseFullPath();
076
077    /**
078     * Returns the manageable service base class name.  This is the manageable session bean
079     * containing the CRUD implementation.
080     * @return String
081     */
082    public String getManageableServiceBaseName();
083
084    /**
085     * Returns the manageable service create exception name.
086     * @return String
087     */
088    public String getManageableServiceCreateExceptionName();
089
090    /**
091     * Returns the manageable service delete exception name.
092     * @return String
093     */
094    public String getManageableServiceDeleteExceptionName();
095
096    /**
097     * Returns the manageable service read exception name.
098     * @return String
099     */
100    public String getManageableServiceReadExceptionName();
101
102    /**
103     * Returns the manageable service update exception name.
104     * @return String
105     */
106    public String getManageableServiceUpdateExceptionName();
107}