1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.webservice.metafacades;
6
7 import org.andromda.metafacades.uml.ParameterFacade;
8
9 /**
10 * Represents a parameter modeled on a webservice.
11 *
12 * Metafacade interface to be used by AndroMDA cartridges.
13 */
14 public interface WebServiceParameter
15 extends ParameterFacade
16 {
17 /**
18 * Indicates the metafacade type (used for metafacade mappings).
19 *
20 * @return boolean always <code>true</code>
21 */
22 public boolean isWebServiceParameterMetaType();
23
24 /**
25 * TODO: Model Documentation for
26 * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restParamType
27 * @return String
28 */
29 public String getRestParamType();
30
31 /**
32 * Customize the REST parameter path in the URL, by default it is /paramname/{paramvalue}/,
33 * appended to the /class/method/ URL.
34 * @return String
35 */
36 public String getRestPathParam();
37
38 /**
39 * TODO: Model Documentation for
40 * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restPathSegment
41 * @return String
42 */
43 public String getRestPathSegment();
44
45 /**
46 * The type name used when calling web service tests.
47 * @return String
48 */
49 public String getTestTypeName();
50
51 /**
52 * Is the parameter an XML attribute?
53 * @return boolean
54 */
55 public boolean isAttribute();
56
57 /**
58 * Is the attribute an XML element?
59 * @return boolean
60 */
61 public boolean isElement();
62
63 /**
64 * Whether or not this webservice parameter is nillable.
65 * @return boolean
66 */
67 public boolean isNillable();
68
69 /**
70 * TODO: Model Documentation for
71 * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restEncoded
72 * @return boolean
73 */
74 public boolean isRestEncoded();
75 }