View Javadoc

1   //
2   // Attention: generated code (by Metafacade.vsl) - do not modify!
3   //
4   package org.andromda.metafacades.uml;
5   
6   /***
7    * 
8    *
9    * Metafacade interface to be used by AndroMDA cartridges.
10   */
11  public interface ParameterFacade
12      extends org.andromda.metafacades.uml.ModelElementFacade
13  {
14  
15      /***
16       * Indicates the metafacade type (used for metafacade mappings).
17       *
18       * @return always <code>true</code>
19       */
20      public boolean isParameterFacadeMetaType();
21  
22     /***
23      * 
24      */
25      public java.lang.String getDefaultValue();
26  
27     /***
28      * <p>
29      * If this parameter is located on an event, this will represent
30      * that event.
31      * </p>
32      */
33      public org.andromda.metafacades.uml.EventFacade getEvent();
34  
35     /***
36      * <p>
37      * The name to use for accessors getting this parameter from a
38      * bean.
39      * </p>
40      */
41      public java.lang.String getGetterName();
42  
43     /***
44      * <p>
45      * the lower value for the multiplicity
46      * </p>
47      * <p>
48      * -only applicable for UML2
49      * </p>
50      */
51      public int getLower();
52  
53     /***
54      * <p>
55      * If this parameter is located on an operation, this will
56      * represent that operation.
57      * </p>
58      */
59      public org.andromda.metafacades.uml.OperationFacade getOperation();
60  
61     /***
62      * <p>
63      * The name to use for accessors getting this parameter in a bean.
64      * </p>
65      */
66      public java.lang.String getSetterName();
67  
68     /***
69      * 
70      */
71      public org.andromda.metafacades.uml.ClassifierFacade getType();
72  
73     /***
74      * <p>
75      * the upper value of the multiplicity (will be -1 for *)
76      * </p>
77      * <p>
78      * -only applicable for UML2
79      * </p>
80      */
81      public int getUpper();
82  
83     /***
84      * <p>
85      * Indicates if the default value is present.
86      * </p>
87      */
88      public boolean isDefaultValuePresent();
89  
90     /***
91      * <p>
92      * True if this parameter is an 'in' parameter.
93      * </p>
94      */
95      public boolean isInParameter();
96  
97     /***
98      * <p>
99      * True if this parameter is an inout parameter.
100     * </p>
101     */
102     public boolean isInoutParameter();
103 
104    /***
105     * <p>
106     * True if this parameter is an 'out' parameter.
107     * </p>
108     */
109     public boolean isOutParameter();
110 
111    /***
112     * <p>
113     * True if this parameter is readable, aka an in-parameter, or this
114     * feature is unspecified.
115     * </p>
116     */
117     public boolean isReadable();
118 
119    /***
120     * <p>
121     * Whether or not this parameter is considered required (i.e must a
122     * non-empty value).
123     * </p>
124     */
125     public boolean isRequired();
126 
127    /***
128     * <p>
129     * Whether or not this parameter represents a return parameter.
130     * </p>
131     */
132     public boolean isReturn();
133 
134    /***
135     * <p>
136     * True if this parameter is writable, aka an out-parameter, or
137     * this feature is unspecified.
138     * </p>
139     */
140     public boolean isWritable();
141 
142 }