com.flexive.shared.structure
Enum LanguageMode

java.lang.Object
  extended by java.lang.Enum<LanguageMode>
      extended by com.flexive.shared.structure.LanguageMode
All Implemented Interfaces:
ObjectWithLabel, java.io.Serializable, java.lang.Comparable<LanguageMode>

public enum LanguageMode
extends java.lang.Enum<LanguageMode>
implements java.io.Serializable, ObjectWithLabel

Definition how languages are handled by a type

Author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Enum Constant Summary
Multiple
          Every property may exist in different languages
None
          Content is not language dependent
Single
          One language per content may be defined
 
Method Summary
static LanguageMode getById(int id)
          Get a LanguageMode by its id
 int getId()
          Getter for the internal id
 FxString getLabel()
          Return the localized label of the object.
 boolean isUpgradeable(LanguageMode newMode)
          Check if the current mode can be upgraded to newMode
static LanguageMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LanguageMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

None

public static final LanguageMode None
Content is not language dependent


Single

public static final LanguageMode Single
One language per content may be defined


Multiple

public static final LanguageMode Multiple
Every property may exist in different languages

Method Detail

values

public static LanguageMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (LanguageMode c : LanguageMode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static LanguageMode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getId

public int getId()
Getter for the internal id

Returns:
internal id

getById

public static LanguageMode getById(int id)
                            throws FxNotFoundException
Get a LanguageMode by its id

Parameters:
id - internal id
Returns:
LanguageMode
Throws:
FxNotFoundException - on errors

isUpgradeable

public boolean isUpgradeable(LanguageMode newMode)
Check if the current mode can be upgraded to newMode

Parameters:
newMode - mode to upgrade to
Returns:
upgradeable

getLabel

public FxString getLabel()
Return the localized label of the object.

Specified by:
getLabel in interface ObjectWithLabel
Returns:
the localized label for the object.