// license-header java merge-point
//
// Attention: generated code (by Metafacade.vsl) - do not modify!
//
package org.andromda.cartridges.spring.metafacades;

import java.util.Collection;
import org.andromda.metafacades.uml.ClassifierFacade;
import org.andromda.metafacades.uml.Entity;

/**
 * Represents a Spring persistent entity
 *
 * Metafacade interface to be used by AndroMDA cartridges.
 */
public interface SpringEntity
    extends Entity
{
    /**
     * Indicates the metafacade type (used for metafacade mappings).
     *
     * @return boolean always <code>true</code>
     */
    public boolean isSpringEntityMetaType();

    /**
     * Returns all value object references (this includes all those that are inherited from any
     * parent entities)
     * @return Collection<ClassifierFacade>
     */
    public Collection<ClassifierFacade> getAllValueObjectReferences();

    /**
     * A quoted comma separated list of the names of embedded values belonging to this entity (that
     * represented as attributes)
     * @return String
     */
    public String getAttributeEmbeddedValueList();

    /**
     * Gets the Spring bean name, and optionally adds a target suffix, if 'targetSuffix' is set to
     * true.
     * @param targetSuffix boolean
     * @return String
     */
    public String getBeanName(boolean targetSuffix);

    /**
     * The DAO base class name.  This is the abstract DAO that contains CRUD operations
     * as well as any generated finders defined on an entity.
     * @return String
     */
    public String getDaoBaseName();

    /**
     * The business operations modeled on the entity that will be generated on the DAO (Data Access
     * Object).
     * @return Collection<SpringEntityOperation>
     */
    public Collection<SpringEntityOperation> getDaoBusinessOperations();

    /**
     * The DAO implementation class name.
     * @return String
     */
    public String getDaoImplementationName();

    /**
     * The name of the DAO for the specified entity.
     * @return String
     */
    public String getDaoName();

    /**
     * The constant name denoting no transformation is to be applied.
     * @return String
     */
    public String getDaoNoTransformationConstantName();

    /**
     * The implementation name for the entity.
     * @return String
     */
    public String getEntityImplementationName();

    /**
     * The name of the plain entity name.
     * @return String
     */
    public String getEntityName();

    /**
     * The fully qualified name of the base DAO.
     * @return String
     */
    public String getFullyQualifiedDaoBaseName();

    /**
     * The fully qualified name of the DAO implemetation.
     * @return String
     */
    public String getFullyQualifiedDaoImplementationName();

    /**
     * The fully qualified name of the DAO.
     * @return String
     */
    public String getFullyQualifiedDaoName();

    /**
     * The fully qualified name of the entity implementation class.
     * @return String
     */
    public String getFullyQualifiedEntityImplementationName();

    /**
     * The fully qualified name of the entity class.
     * @return String
     */
    public String getFullyQualifiedEntityName();

    /**
     * Return the value of the tagged value andromda_hibernate_inheritance.
     * @return String
     */
    public String getHibernateInheritanceStrategy();

    /**
     * Travels up the inheritance hierarchy and retrieves the root of this entity.  If the root is
     * the entity itself then just the entity is returned.
     * @return SpringEntity
     */
    public SpringEntity getRoot();

    /**
     * A Classifier is a classification of instances - it describes a set of instances that have
     * features
     * in common. Can specify a generalization hierarchy by referencing its general classifiers. It
     * may be
     * a Class, DataType, PrimitiveType, Association, Collaboration, UseCase, etc. Can specify a
     * generalization hierarchy by referencing its general classifiers. Has the capability to own
     * collaboration uses. These collaboration uses link a collaboration with the classifier to give
     * a
     * description of the workings of the classifier. Classifier is defined to be a kind of
     * templateable
     * element so that a classifier can be parameterized. It is also defined to be a kind of
     * parameterable
     * element so that a classifier can be a formal template parameter.
     * @return Collection<ClassifierFacade>
     */
    public Collection<ClassifierFacade> getValueObjectReferences();

    /**
     * Indicates whether or not any business DAO operations are present.
     * @return boolean
     */
    public boolean isDaoBusinessOperationsPresent();

    /**
     * True if an implementation is required for the dao class, this is the case when there are
     * business operations or value-object transformation.
     * @return boolean
     */
    public boolean isDaoImplementationRequired();

    /**
     * Return true if the hibernate inheritance strategy is class.
     * @return boolean
     */
    public boolean isHibernateInheritanceClass();

    /**
     * Return true if the hibernate inheritance strategy is concrete.
     * @return boolean
     */
    public boolean isHibernateInheritanceConcrete();

    /**
     * Return true if the hibernate inheritance strategy is interface.
     * @return boolean
     */
    public boolean isHibernateInheritanceInterface();

    /**
     * Return true if the hibernate inheritance strategy is subclass.
     * @return boolean
     */
    public boolean isHibernateInheritanceSubclass();

    /**
     * Indicates whether or not this entity requires a Hibernate mapping cfg.xml file within the
     * Spring application context.
     * @return boolean
     */
    public boolean isRequiresHibernateMapping();

    /**
     * Returns true if this entity is meant to be used in a richt client application.
     * @return boolean
     */
    public boolean isRichClient();
}