View Javadoc
1   // license-header java merge-point
2   //
3   // Attention: generated code (by Metafacade.vsl) - do not modify!
4   //
5   package org.andromda.cartridges.spring.metafacades;
6   
7   import org.andromda.metafacades.uml.EntityQueryOperation;
8   import org.andromda.metafacades.uml.ParameterFacade;
9   
10  /**
11   * Represents a Spring entity query operation.
12   *
13   * Metafacade interface to be used by AndroMDA cartridges.
14   */
15  public interface SpringQueryOperation
16      extends EntityQueryOperation
17  {
18      /**
19       * Indicates the metafacade type (used for metafacade mappings).
20       *
21       * @return boolean always <code>true</code>
22       */
23      public boolean isSpringQueryOperationMetaType();
24  
25      /**
26       * Returns the argument that will contain the criteria search parameters.
27       * @return ParameterFacade
28       */
29      public ParameterFacade getCriteriaArgument();
30  
31      /**
32       * The actual query returned for the body of the finder.
33       * @return String
34       */
35      public String getQuery();
36  
37      /**
38       * Gets the query; taking the entity of which should be included in the query (not counting
39       * queries that are explicitly modeled in OCL).
40       * @param entity SpringEntity
41       * @return String
42       */
43      public String getQuery(SpringEntity entity);
44  
45      /**
46       * Returns <code>true</code> if the operation is a criteria finder.
47       * @return boolean
48       */
49      public boolean isCriteriaFinder();
50  
51      /**
52       * Indicates whether or not the query parameters used for the body of the finder should be named
53       * ':someParam' or unnamed '?'.
54       * @return boolean
55       */
56      public boolean isUseNamedParameters();
57  }