001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.webservice.metafacades;
006
007import org.andromda.metafacades.uml.ParameterFacade;
008
009/**
010 * Represents a parameter modeled on a webservice.
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface WebServiceParameter
015    extends ParameterFacade
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isWebServiceParameterMetaType();
023
024    /**
025     * TODO: Model Documentation for
026     * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restParamType
027     * @return String
028     */
029    public String getRestParamType();
030
031    /**
032     * Customize the REST parameter path in the URL, by default it is /paramname/{paramvalue}/,
033     * appended to the /class/method/ URL.
034     * @return String
035     */
036    public String getRestPathParam();
037
038    /**
039     * TODO: Model Documentation for
040     * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restPathSegment
041     * @return String
042     */
043    public String getRestPathSegment();
044
045    /**
046     * The type name used when calling web service tests.
047     * @return String
048     */
049    public String getTestTypeName();
050
051    /**
052     * Is the parameter an XML attribute?
053     * @return boolean
054     */
055    public boolean isAttribute();
056
057    /**
058     * Is the attribute an XML element?
059     * @return boolean
060     */
061    public boolean isElement();
062
063    /**
064     * Whether or not this webservice parameter is nillable.
065     * @return boolean
066     */
067    public boolean isNillable();
068
069    /**
070     * TODO: Model Documentation for
071     * org.andromda.cartridges.webservice.metafacades.WebServiceParameter.restEncoded
072     * @return boolean
073     */
074    public boolean isRestEncoded();
075}