001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.spring.metafacades;
006
007import org.andromda.metafacades.uml.DependencyFacade;
008
009/**
010 * Represents a dependency between spring objects.
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface SpringDependency
015    extends DependencyFacade
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isSpringDependencyMetaType();
023
024    /**
025     * The name of the DAO reference getter name.
026     * @return String
027     */
028    public String getDaoGetterName();
029
030    /**
031     * The name given to a DAO reference.
032     * @return String
033     */
034    public String getDaoName();
035
036    /**
037     * The DAO reference setter's name.
038     * @return String
039     */
040    public String getDaoSetterName();
041
042    /**
043     * TODO: Model Documentation for
044     * org.andromda.cartridges.spring.metafacades.SpringDependency.transformationAnonymousName
045     * @return String
046     */
047    public String getTransformationAnonymousName();
048
049    /**
050     * The name of the constant designated for use as a transformation flag for value objects (only
051     * makes sense when this dependency goes into a value object).
052     * @return String
053     */
054    public String getTransformationConstantName();
055
056    /**
057     * Stores the transformation constrant name.
058     * @return int
059     */
060    public int getTransformationConstantValue();
061
062    /**
063     * The name of the method use for transformation into a value object (only makes sense when this
064     * dependency goes into a value object).
065     * @return String
066     */
067    public String getTransformationMethodName();
068
069    /**
070     * Returns the name of the method for transforming the contents of a collection to an array.
071     * @return String
072     */
073    public String getTransformationToArrayMethodName();
074
075    /**
076     * Returns the name of the method for transforming the contents of a collection.
077     * @return String
078     */
079    public String getTransformationToCollectionMethodName();
080
081    /**
082     * The method name that performs the value object collection to entity collection
083     * transformation.
084     * @return String
085     */
086    public String getTransformationToEntityCollectionMethodName();
087
088    /**
089     * The name of the "to entity" transformation method name.
090     * @return String
091     */
092    public String getTransformationToEntityMethodName();
093
094    /**
095     * The name of the class that performs the value object to entity transformation.
096     * @return String
097     */
098    public String getValueObjectToEntityTransformerName();
099
100    /**
101     * Indicates if this dependency is part of a circular reference (meaning that both entities
102     * reference each other).
103     * @return boolean
104     */
105    public boolean isCircularReference();
106}