001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.metafacades.uml;
006
007/**
008 * A user-defined data value for an enumeration.
009 *
010 * Metafacade interface to be used by AndroMDA cartridges.
011 */
012public interface EnumerationLiteralFacade
013    extends ModelElementFacade
014{
015    /**
016     * Indicates the metafacade type (used for metafacade mappings).
017     *
018     * @return boolean always <code>true</code>
019     */
020    public boolean isEnumerationLiteralFacadeMetaType();
021
022    /**
023     * Gets the Literal's Value. This will be used to create the Literal's Instance.
024     * @return String
025     */
026    public String getEnumerationValue();
027
028    /**
029     * Gets the name of the enumeration literal (if the "modelName" flag is true, then the actual
030     * name of the literal in the model is returned - otherwise the name that has any masking
031     * applied).
032     * @param modelName boolean
033     * @return String
034     */
035    public String getName(boolean modelName);
036
037    /**
038     * Returns the value of this enumeration literal, by default the value is the same as the name.
039     * @return String
040     */
041    public String getValue();
042
043    /**
044     * Gets the value of the enumeration literal  (if the "modelValue" flag is true, then the actual
045     * value of the literal in the model is returned - otherwise the value that has any masking
046     * applied is returned).
047     * @param modelValue boolean
048     * @return String
049     */
050    public String getValue(boolean modelValue);
051}