EnumState (XJdfLib 0.1 API)

java.lang.Object
- org.cip4.lib.xjdf.schema.jdf.EnumState

All Implemented Interfaces:: java.io.Serializable

public class EnumState
extends java.lang.Object
implements java.io.Serializable

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element ref="{http://www.CIP4.org/JDFSchema_2_0}ValueLoc" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{http://www.CIP4.org/JDFSchema_2_0}Loc" maxOccurs="unbounded" minOccurs="0"/>
         </choice>
       </sequence>
       <attribute name="UserDisplay" type="{http://www.CIP4.org/JDFSchema_2_0}EnumUserDisplay" />
       <attribute name="HasDefault" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="Required" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="AllowedRegExp" type="{http://www.CIP4.org/JDFSchema_2_0}RegExp" />
       <attribute name="Editable" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="MaxOccurs" type="{http://www.CIP4.org/JDFSchema_2_0}unbounded" />
       <attribute name="CurrentValue" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKEN" />
       <attribute name="PresentValueList" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKENS" />
       <attribute name="ID" type="{http://www.CIP4.org/JDFSchema_2_0}ID" />
       <attribute name="AllowedValueList" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKENS" />
       <attribute name="DevNS" type="{http://www.CIP4.org/JDFSchema_2_0}URI" />
       <attribute name="Availability" type="{http://www.CIP4.org/JDFSchema_2_0}EnumAvailability" />
       <attribute name="ListType" type="{http://www.CIP4.org/JDFSchema_2_0}EnumListType" />
       <attribute name="MinOccurs" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="ModuleRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="MacroRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="ActionRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="DependentMacroRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
       <attribute name="DefaultValue" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKEN" />
       <attribute name="PresentRegExp" type="{http://www.CIP4.org/JDFSchema_2_0}RegExp" />
       <attribute name="XPath" use="required" type="{http://www.CIP4.org/JDFSchema_2_0}XPath" />
       <attribute name="XPathRoot" type="{http://www.CIP4.org/JDFSchema_2_0}XPath" />
       <attribute name="DescriptiveName" type="{http://www.CIP4.org/JDFSchema_2_0}string" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<java.lang.Object>`	`actionRefs`
`protected java.lang.String`	`allowedRegExp`
`protected java.util.List<java.lang.String>`	`allowedValueLists`
`protected EnumAvailability`	`availability`
`protected java.lang.String`	`currentValue`
`protected java.lang.String`	`defaultValue`
`protected java.lang.Object`	`dependentMacroRef`
`protected java.lang.String`	`descriptiveName`
`protected java.lang.String`	`devNS`
`protected java.lang.Boolean`	`editable`
`protected java.lang.Boolean`	`hasDefault`
`protected java.lang.String`	`id`
`protected EnumListType`	`listType`
`protected java.util.List<Loc>`	`locs`
`protected java.util.List<java.lang.Object>`	`macroRefs`
`protected java.lang.String`	`maxOccurs`
`protected java.lang.Integer`	`minOccurs`
`protected java.util.List<java.lang.Object>`	`moduleRefs`
`protected java.lang.String`	`presentRegExp`
`protected java.util.List<java.lang.String>`	`presentValueLists`
`protected java.lang.Boolean`	`required`
`protected EnumUserDisplay`	`userDisplay`
`protected java.util.List<ValueLoc>`	`valueLocs`
`protected java.lang.String`	`xPath`
`protected java.lang.String`	`xPathRoot`

Constructor Summary

Constructors
Constructor and Description

EnumState()

Constructors
Constructor and Description
`EnumState()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.Object>`	`getActionRefs()` Gets the value of the actionRefs property.
`java.lang.String`	`getAllowedRegExp()` Gets the value of the allowedRegExp property.
`java.util.List<java.lang.String>`	`getAllowedValueLists()` Gets the value of the allowedValueLists property.
`EnumAvailability`	`getAvailability()` Gets the value of the availability property.
`java.lang.String`	`getCurrentValue()` Gets the value of the currentValue property.
`java.lang.String`	`getDefaultValue()` Gets the value of the defaultValue property.
`java.lang.Object`	`getDependentMacroRef()` Gets the value of the dependentMacroRef property.
`java.lang.String`	`getDescriptiveName()` Gets the value of the descriptiveName property.
`java.lang.String`	`getDevNS()` Gets the value of the devNS property.
`java.lang.Boolean`	`getEditable()` Gets the value of the editable property.
`java.lang.Boolean`	`getHasDefault()` Gets the value of the hasDefault property.
`java.lang.String`	`getID()` Gets the value of the id property.
`EnumListType`	`getListType()` Gets the value of the listType property.
`java.util.List<Loc>`	`getLocs()` Gets the value of the locs property.
`java.util.List<java.lang.Object>`	`getMacroRefs()` Gets the value of the macroRefs property.
`java.lang.String`	`getMaxOccurs()` Gets the value of the maxOccurs property.
`java.lang.Integer`	`getMinOccurs()` Gets the value of the minOccurs property.
`java.util.List<java.lang.Object>`	`getModuleRefs()` Gets the value of the moduleRefs property.
`java.lang.String`	`getPresentRegExp()` Gets the value of the presentRegExp property.
`java.util.List<java.lang.String>`	`getPresentValueLists()` Gets the value of the presentValueLists property.
`java.lang.Boolean`	`getRequired()` Gets the value of the required property.
`EnumUserDisplay`	`getUserDisplay()` Gets the value of the userDisplay property.
`java.util.List<ValueLoc>`	`getValueLocs()` Gets the value of the valueLocs property.
`java.lang.String`	`getXPath()` Gets the value of the xPath property.
`java.lang.String`	`getXPathRoot()` Gets the value of the xPathRoot property.
`void`	`setAllowedRegExp(java.lang.String value)` Sets the value of the allowedRegExp property.
`void`	`setAvailability(EnumAvailability value)` Sets the value of the availability property.
`void`	`setCurrentValue(java.lang.String value)` Sets the value of the currentValue property.
`void`	`setDefaultValue(java.lang.String value)` Sets the value of the defaultValue property.
`void`	`setDependentMacroRef(java.lang.Object value)` Sets the value of the dependentMacroRef property.
`void`	`setDescriptiveName(java.lang.String value)` Sets the value of the descriptiveName property.
`void`	`setDevNS(java.lang.String value)` Sets the value of the devNS property.
`void`	`setEditable(java.lang.Boolean value)` Sets the value of the editable property.
`void`	`setHasDefault(java.lang.Boolean value)` Sets the value of the hasDefault property.
`void`	`setID(java.lang.String value)` Sets the value of the id property.
`void`	`setListType(EnumListType value)` Sets the value of the listType property.
`void`	`setMaxOccurs(java.lang.String value)` Sets the value of the maxOccurs property.
`void`	`setMinOccurs(java.lang.Integer value)` Sets the value of the minOccurs property.
`void`	`setPresentRegExp(java.lang.String value)` Sets the value of the presentRegExp property.
`void`	`setRequired(java.lang.Boolean value)` Sets the value of the required property.
`void`	`setUserDisplay(EnumUserDisplay value)` Sets the value of the userDisplay property.
`void`	`setXPath(java.lang.String value)` Sets the value of the xPath property.
`void`	`setXPathRoot(java.lang.String value)` Sets the value of the xPathRoot property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - locs
```
protected java.util.List<Loc> locs
```
  - valueLocs
```
protected java.util.List<ValueLoc> valueLocs
```
  - userDisplay
```
protected EnumUserDisplay userDisplay
```
  - hasDefault
```
protected java.lang.Boolean hasDefault
```
  - required
```
protected java.lang.Boolean required
```
  - allowedRegExp
```
protected java.lang.String allowedRegExp
```
  - editable
```
protected java.lang.Boolean editable
```
  - maxOccurs
```
protected java.lang.String maxOccurs
```
  - currentValue
```
protected java.lang.String currentValue
```
  - presentValueLists
```
protected java.util.List<java.lang.String> presentValueLists
```
  - id
```
protected java.lang.String id
```
  - allowedValueLists
```
protected java.util.List<java.lang.String> allowedValueLists
```
  - devNS
```
protected java.lang.String devNS
```
  - availability
```
protected EnumAvailability availability
```
  - listType
```
protected EnumListType listType
```
  - minOccurs
```
protected java.lang.Integer minOccurs
```
  - moduleRefs
```
protected java.util.List<java.lang.Object> moduleRefs
```
  - macroRefs
```
protected java.util.List<java.lang.Object> macroRefs
```
  - actionRefs
```
protected java.util.List<java.lang.Object> actionRefs
```
  - dependentMacroRef
```
protected java.lang.Object dependentMacroRef
```
  - defaultValue
```
protected java.lang.String defaultValue
```
  - presentRegExp
```
protected java.lang.String presentRegExp
```
  - xPath
```
protected java.lang.String xPath
```
  - xPathRoot
```
protected java.lang.String xPathRoot
```
  - descriptiveName
```
protected java.lang.String descriptiveName
```
- Constructor Detail
  - EnumState
```
public EnumState()
```
- Method Detail
  - getLocs
```
public java.util.List<Loc> getLocs()
```
    Gets the value of the locs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the locs property.
    For example, to add a new item, do as follows:
```
    getLocs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Loc
  - getValueLocs
```
public java.util.List<ValueLoc> getValueLocs()
```
    Gets the value of the valueLocs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the valueLocs property.
    For example, to add a new item, do as follows:
```
    getValueLocs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ValueLoc
  - getUserDisplay
```
public EnumUserDisplay getUserDisplay()
```
    Gets the value of the userDisplay property.
    
    Returns:
    possible object is EnumUserDisplay
  - setUserDisplay
```
public void setUserDisplay(EnumUserDisplay value)
```
    Sets the value of the userDisplay property.
    
    Parameters:
    value - allowed object is EnumUserDisplay
  - getHasDefault
```
public java.lang.Boolean getHasDefault()
```
    Gets the value of the hasDefault property.
    
    Returns:
    possible object is Boolean
  - setHasDefault
```
public void setHasDefault(java.lang.Boolean value)
```
    Sets the value of the hasDefault property.
    
    Parameters:
    value - allowed object is Boolean
  - getRequired
```
public java.lang.Boolean getRequired()
```
    Gets the value of the required property.
    
    Returns:
    possible object is Boolean
  - setRequired
```
public void setRequired(java.lang.Boolean value)
```
    Sets the value of the required property.
    
    Parameters:
    value - allowed object is Boolean
  - getAllowedRegExp
```
public java.lang.String getAllowedRegExp()
```
    Gets the value of the allowedRegExp property.
    
    Returns:
    possible object is String
  - setAllowedRegExp
```
public void setAllowedRegExp(java.lang.String value)
```
    Sets the value of the allowedRegExp property.
    
    Parameters:
    value - allowed object is String
  - getEditable
```
public java.lang.Boolean getEditable()
```
    Gets the value of the editable property.
    
    Returns:
    possible object is Boolean
  - setEditable
```
public void setEditable(java.lang.Boolean value)
```
    Sets the value of the editable property.
    
    Parameters:
    value - allowed object is Boolean
  - getMaxOccurs
```
public java.lang.String getMaxOccurs()
```
    Gets the value of the maxOccurs property.
    
    Returns:
    possible object is String
  - setMaxOccurs
```
public void setMaxOccurs(java.lang.String value)
```
    Sets the value of the maxOccurs property.
    
    Parameters:
    value - allowed object is String
  - getCurrentValue
```
public java.lang.String getCurrentValue()
```
    Gets the value of the currentValue property.
    
    Returns:
    possible object is String
  - setCurrentValue
```
public void setCurrentValue(java.lang.String value)
```
    Sets the value of the currentValue property.
    
    Parameters:
    value - allowed object is String
  - getPresentValueLists
```
public java.util.List<java.lang.String> getPresentValueLists()
```
    Gets the value of the presentValueLists property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the presentValueLists property.
    For example, to add a new item, do as follows:
```
    getPresentValueLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getID
```
public java.lang.String getID()
```
    Gets the value of the id property.
    
    Returns:
    possible object is String
  - setID
```
public void setID(java.lang.String value)
```
    Sets the value of the id property.
    
    Parameters:
    value - allowed object is String
  - getAllowedValueLists
```
public java.util.List<java.lang.String> getAllowedValueLists()
```
    Gets the value of the allowedValueLists property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the allowedValueLists property.
    For example, to add a new item, do as follows:
```
    getAllowedValueLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getDevNS
```
public java.lang.String getDevNS()
```
    Gets the value of the devNS property.
    
    Returns:
    possible object is String
  - setDevNS
```
public void setDevNS(java.lang.String value)
```
    Sets the value of the devNS property.
    
    Parameters:
    value - allowed object is String
  - getAvailability
```
public EnumAvailability getAvailability()
```
    Gets the value of the availability property.
    
    Returns:
    possible object is EnumAvailability
  - setAvailability
```
public void setAvailability(EnumAvailability value)
```
    Sets the value of the availability property.
    
    Parameters:
    value - allowed object is EnumAvailability
  - getListType
```
public EnumListType getListType()
```
    Gets the value of the listType property.
    
    Returns:
    possible object is EnumListType
  - setListType
```
public void setListType(EnumListType value)
```
    Sets the value of the listType property.
    
    Parameters:
    value - allowed object is EnumListType
  - getMinOccurs
```
public java.lang.Integer getMinOccurs()
```
    Gets the value of the minOccurs property.
    
    Returns:
    possible object is Integer
  - setMinOccurs
```
public void setMinOccurs(java.lang.Integer value)
```
    Sets the value of the minOccurs property.
    
    Parameters:
    value - allowed object is Integer
  - getModuleRefs
```
public java.util.List<java.lang.Object> getModuleRefs()
```
    Gets the value of the moduleRefs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the moduleRefs property.
    For example, to add a new item, do as follows:
```
    getModuleRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getMacroRefs
```
public java.util.List<java.lang.Object> getMacroRefs()
```
    Gets the value of the macroRefs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the macroRefs property.
    For example, to add a new item, do as follows:
```
    getMacroRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getActionRefs
```
public java.util.List<java.lang.Object> getActionRefs()
```
    Gets the value of the actionRefs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the actionRefs property.
    For example, to add a new item, do as follows:
```
    getActionRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getDependentMacroRef
```
public java.lang.Object getDependentMacroRef()
```
    Gets the value of the dependentMacroRef property.
    
    Returns:
    possible object is Object
  - setDependentMacroRef
```
public void setDependentMacroRef(java.lang.Object value)
```
    Sets the value of the dependentMacroRef property.
    
    Parameters:
    value - allowed object is Object
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    Gets the value of the defaultValue property.
    
    Returns:
    possible object is String
  - setDefaultValue
```
public void setDefaultValue(java.lang.String value)
```
    Sets the value of the defaultValue property.
    
    Parameters:
    value - allowed object is String
  - getPresentRegExp
```
public java.lang.String getPresentRegExp()
```
    Gets the value of the presentRegExp property.
    
    Returns:
    possible object is String
  - setPresentRegExp
```
public void setPresentRegExp(java.lang.String value)
```
    Sets the value of the presentRegExp property.
    
    Parameters:
    value - allowed object is String
  - getXPath
```
public java.lang.String getXPath()
```
    Gets the value of the xPath property.
    
    Returns:
    possible object is String
  - setXPath
```
public void setXPath(java.lang.String value)
```
    Sets the value of the xPath property.
    
    Parameters:
    value - allowed object is String
  - getXPathRoot
```
public java.lang.String getXPathRoot()
```
    Gets the value of the xPathRoot property.
    
    Returns:
    possible object is String
  - setXPathRoot
```
public void setXPathRoot(java.lang.String value)
```
    Sets the value of the xPathRoot property.
    
    Parameters:
    value - allowed object is String
  - getDescriptiveName
```
public java.lang.String getDescriptiveName()
```
    Gets the value of the descriptiveName property.
    
    Returns:
    possible object is String
  - setDescriptiveName
```
public void setDescriptiveName(java.lang.String value)
```
    Sets the value of the descriptiveName property.
    
    Parameters:
    value - allowed object is String

Class EnumState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

locs

valueLocs

userDisplay

hasDefault

required

allowedRegExp

editable

maxOccurs

currentValue

presentValueLists

id

allowedValueLists

devNS

availability

listType

minOccurs

moduleRefs

macroRefs

actionRefs

dependentMacroRef

defaultValue

presentRegExp

xPath

xPathRoot

descriptiveName

Constructor Detail

EnumState

Method Detail

getLocs

getValueLocs

getUserDisplay

setUserDisplay

getHasDefault

setHasDefault

getRequired

setRequired

getAllowedRegExp

setAllowedRegExp

getEditable

setEditable

getMaxOccurs

setMaxOccurs

getCurrentValue

setCurrentValue

getPresentValueLists

getID

setID

getAllowedValueLists

getDevNS

setDevNS

getAvailability

setAvailability

getListType

setListType

getMinOccurs

setMinOccurs

getModuleRefs

getMacroRefs

getActionRefs

getDependentMacroRef

setDependentMacroRef

getDefaultValue

setDefaultValue

getPresentRegExp

setPresentRegExp

getXPath

setXPath

getXPathRoot

setXPathRoot

getDescriptiveName

setDescriptiveName