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