View Javadoc

1   //
2   // Attention: generated code (by Metafacade.vsl) - do not modify!
3   //
4   package org.andromda.cartridges.spring.metafacades;
5   
6   /***
7    * <p>
8    * Represents a criteria search attribute.
9    * </p>
10   *
11   * Metafacade interface to be used by AndroMDA cartridges.
12   */
13  public interface SpringCriteriaAttribute
14      extends org.andromda.metafacades.uml.AttributeFacade
15  {
16  
17      /***
18       * Indicates the metafacade type (used for metafacade mappings).
19       *
20       * @return always <code>true</code>
21       */
22      public boolean isSpringCriteriaAttributeMetaType();
23  
24     /***
25      * <p>
26      * Returns the name of the attribute to be used in the criteria
27      * query.
28      * </p>
29      */
30      public java.lang.String getAttributeName();
31  
32     /***
33      * <p>
34      * Returns the comparator for the attribute.
35      * </p>
36      */
37      public java.lang.String getComparator();
38  
39     /***
40      * <p>
41      * The comparator as a constant expression usable in the template.
42      * </p>
43      */
44      public java.lang.String getComparatorConstant();
45  
46     /***
47      * <p>
48      * Returns the hibernate matchmode constant to use for matching
49      * Strings.
50      * </p>
51      */
52      public java.lang.String getMatchMode();
53  
54     /***
55      * <p>
56      * Returns the matchmode constant for usage in templates.
57      * </p>
58      */
59      public java.lang.String getMatchModeConstant();
60  
61     /***
62      * <p>
63      * Returns the order direction if it has been set.
64      * </p>
65      */
66      public java.lang.String getOrderDirection();
67  
68     /***
69      * <p>
70      * Returns the relevance of the ordering setting. The lower the
71      * number, the more relevant it is.
72      * </p>
73      */
74      public int getOrderRelevance();
75  
76     /***
77      * <p>
78      * Indicates whether or not the attribute has a tagged value for
79      * the comparator.
80      * </p>
81      */
82      public boolean isComparatorPresent();
83  
84     /***
85      * <p>
86      * Returns <code>true</code> if a matchmode has ben set.
87      * </p>
88      */
89      public boolean isMatchModePresent();
90  
91     /***
92      * <p>
93      * Defines whether the underlying attribute on the queried entity
94      * may be NULL and should therefore be included in the search.
95      * </p>
96      */
97      public boolean isNullable();
98  
99     /***
100     * <p>
101     * Returns true if the attribute is used to order the result set.
102     * </p>
103     */
104     public boolean isOrderable();
105 
106 }