biz.c24.io.api.data
Class FormEnum

java.lang.Object
  extended by biz.c24.io.api.data.FormEnum
All Implemented Interfaces:
Serializable

public final class FormEnum
extends Object
implements Serializable

An enumeration of possible form values.

Form values are used to specify whether references are fully qualfiied.

See Also:
Serialized Form

Field Summary
static FormEnum QUALIFIED
          Specifies that locally declared elements / attributes should be qualified.
static FormEnum UNQUALIFIED
          Specifies that locally declared elements / attributes should not be qualified.
static FormEnum UNSPECIFIED
          Specifies that the form value should be inherited from the data model.
 
Method Summary
static FormEnum[] getEnumArray()
          Returns an array containing the members of this enumeration.
static FormEnum getEnumValue(String name)
          Returns the enumeration value called name.
 String getName()
          Returns the name.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNSPECIFIED

public static final FormEnum UNSPECIFIED
Specifies that the form value should be inherited from the data model. If this value appears on an element then the "element form default" value of the data model will be used. If this value appears on an attribute then the "attribute form default" value of the data model will be used.


QUALIFIED

public static final FormEnum QUALIFIED
Specifies that locally declared elements / attributes should be qualified.


UNQUALIFIED

public static final FormEnum UNQUALIFIED
Specifies that locally declared elements / attributes should not be qualified.

Method Detail

getName

public String getName()
Returns the name.

Returns:
The name.

toString

public String toString()
Overrides:
toString in class Object

getEnumArray

public static FormEnum[] getEnumArray()
Returns an array containing the members of this enumeration.

Returns:
The enumeration as an array.

getEnumValue

public static FormEnum getEnumValue(String name)
Returns the enumeration value called name.

Parameters:
name - The name of the enumeration value to return.
Returns:
The enumeration value or null if none was found.


C24 Technologies © 2002-2012: All Rights Reserved.