com.cisco.oss.foundation.configuration.xml.jaxb
Class Parameter

java.lang.Object
  com.cisco.oss.foundation.configuration.xml.jaxb.Parameter

All Implemented Interfaces:

Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.ToString

public class Parameter
extends Object
implements Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.ToString

Java class for Parameter complex type.

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

 <complexType name="Parameter">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <sequence>
           <element name="StructureDefinition" type="{}StructureDefinition"/>
           <element name="Value" type="{}ParameterValue" minOccurs="0"/>
           <element name="DefaultValue" type="{}ParameterValue" minOccurs="0"/>
           <element name="EnabledBy" type="{}EnabledBy" minOccurs="0"/>
           <element name="DiscoveredBy" type="{}DiscoveredBy" minOccurs="0"/>
         </sequence>
         <sequence>
           <element name="Value" type="{}ParameterValue" minOccurs="0"/>
           <element name="DefaultValue" type="{}ParameterValue" minOccurs="0"/>
           <element name="Range" type="{}ParameterRange" minOccurs="0"/>
           <element name="EnabledBy" type="{}EnabledBy" minOccurs="0"/>
           <element name="DiscoveredBy" type="{}DiscoveredBy" minOccurs="0"/>
         </sequence>
       </choice>
       <attribute name="paramId" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" use="required" type="{}ParameterKind" />
       <attribute name="instantiationLevelId" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="instantiationLevelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="instantiationLevel" type="{}HierarchyLevel" />
       <attribute name="defaultInstantiationLevelId" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="description" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="isArray" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="mergeOverrides" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="hidden" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="readOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="advanced" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="requiresRestart" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="unit" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="base" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected Boolean	advanced
protected String	base
protected String	defaultInstantiationLevelId
protected ParameterValue	defaultValue
protected String	description
protected DiscoveredBy	discoveredBy
protected EnabledBy	enabledBy
protected Boolean	hidden
protected HierarchyLevel	instantiationLevel
protected String	instantiationLevelId
protected String	instantiationLevelName
protected Boolean	isArray
protected Boolean	mergeOverrides
protected String	name
protected String	paramId
protected ParameterRange	range
protected Boolean	readOnly
protected Boolean	required
protected Boolean	requiresRestart
protected StructureDefinition	structureDefinition
protected ParameterKind	type
protected String	unit
protected ParameterValue	value

Constructor Summary

Parameter()

Method Summary

StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
Object	clone()
Object	copyTo(Object target)
Object	copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
String	getBase() Gets the value of the base property.
String	getDefaultInstantiationLevelId() Gets the value of the defaultInstantiationLevelId property.
ParameterValue	getDefaultValue() Gets the value of the defaultValue property.
String	getDescription() Gets the value of the description property.
DiscoveredBy	getDiscoveredBy() Gets the value of the discoveredBy property.
EnabledBy	getEnabledBy() Gets the value of the enabledBy property.
HierarchyLevel	getInstantiationLevel() Gets the value of the instantiationLevel property.
String	getInstantiationLevelId() Gets the value of the instantiationLevelId property.
String	getInstantiationLevelName() Gets the value of the instantiationLevelName property.
String	getName() Gets the value of the name property.
String	getParamId() Gets the value of the paramId property.
ParameterRange	getRange() Gets the value of the range property.
StructureDefinition	getStructureDefinition() Gets the value of the structureDefinition property.
ParameterKind	getType() Gets the value of the type property.
String	getUnit() Gets the value of the unit property.
ParameterValue	getValue() Gets the value of the value property.
boolean	isAdvanced() Gets the value of the advanced property.
boolean	isHidden() Gets the value of the hidden property.
boolean	isIsArray() Gets the value of the isArray property.
boolean	isMergeOverrides() Gets the value of the mergeOverrides property.
boolean	isReadOnly() Gets the value of the readOnly property.
boolean	isRequired() Gets the value of the required property.
boolean	isRequiresRestart() Gets the value of the requiresRestart property.
void	setAdvanced(Boolean value) Sets the value of the advanced property.
void	setBase(String value) Sets the value of the base property.
void	setDefaultInstantiationLevelId(String value) Sets the value of the defaultInstantiationLevelId property.
void	setDefaultValue(ParameterValue value) Sets the value of the defaultValue property.
void	setDescription(String value) Sets the value of the description property.
void	setDiscoveredBy(DiscoveredBy value) Sets the value of the discoveredBy property.
void	setEnabledBy(EnabledBy value) Sets the value of the enabledBy property.
void	setHidden(Boolean value) Sets the value of the hidden property.
void	setInstantiationLevel(HierarchyLevel value) Sets the value of the instantiationLevel property.
void	setInstantiationLevelId(String value) Sets the value of the instantiationLevelId property.
void	setInstantiationLevelName(String value) Sets the value of the instantiationLevelName property.
void	setIsArray(Boolean value) Sets the value of the isArray property.
void	setMergeOverrides(Boolean value) Sets the value of the mergeOverrides property.
void	setName(String value) Sets the value of the name property.
void	setParamId(String value) Sets the value of the paramId property.
void	setRange(ParameterRange value) Sets the value of the range property.
void	setReadOnly(Boolean value) Sets the value of the readOnly property.
void	setRequired(Boolean value) Sets the value of the required property.
void	setRequiresRestart(Boolean value) Sets the value of the requiresRestart property.
void	setStructureDefinition(StructureDefinition value) Sets the value of the structureDefinition property.
void	setType(ParameterKind value) Sets the value of the type property.
void	setUnit(String value) Sets the value of the unit property.
void	setValue(ParameterValue value) Sets the value of the value property.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

structureDefinition

protected StructureDefinition structureDefinition

value

protected ParameterValue value

defaultValue

protected ParameterValue defaultValue

range

protected ParameterRange range

enabledBy

protected EnabledBy enabledBy

discoveredBy

protected DiscoveredBy discoveredBy

paramId

protected String paramId

name

protected String name

type

protected ParameterKind type

instantiationLevelId

protected String instantiationLevelId

instantiationLevelName

protected String instantiationLevelName

instantiationLevel

protected HierarchyLevel instantiationLevel

defaultInstantiationLevelId

protected String defaultInstantiationLevelId

description

protected String description

isArray

protected Boolean isArray

mergeOverrides

protected Boolean mergeOverrides

required

protected Boolean required

hidden

protected Boolean hidden

readOnly

protected Boolean readOnly

advanced

protected Boolean advanced

requiresRestart

protected Boolean requiresRestart

unit

protected String unit

base

protected String base

Constructor Detail

Parameter

public Parameter()

Method Detail

getStructureDefinition

public StructureDefinition getStructureDefinition()

Gets the value of the structureDefinition property.

Returns:

possible object is StructureDefinition

setStructureDefinition

public void setStructureDefinition(StructureDefinition value)

Sets the value of the structureDefinition property.

Parameters:

value - allowed object is StructureDefinition

getValue

public ParameterValue getValue()

Gets the value of the value property.

Returns:

possible object is ParameterValue

setValue

public void setValue(ParameterValue value)

Sets the value of the value property.

Parameters:

value - allowed object is ParameterValue

getDefaultValue

public ParameterValue getDefaultValue()

Gets the value of the defaultValue property.

Returns:

possible object is ParameterValue

setDefaultValue

public void setDefaultValue(ParameterValue value)

Sets the value of the defaultValue property.

Parameters:

value - allowed object is ParameterValue

getRange

public ParameterRange getRange()

Gets the value of the range property.

Returns:

possible object is ParameterRange

setRange

public void setRange(ParameterRange value)

Sets the value of the range property.

Parameters:

value - allowed object is ParameterRange

getEnabledBy

public EnabledBy getEnabledBy()

Gets the value of the enabledBy property.

Returns:

possible object is EnabledBy

setEnabledBy

public void setEnabledBy(EnabledBy value)

Sets the value of the enabledBy property.

Parameters:

value - allowed object is EnabledBy

getDiscoveredBy

public DiscoveredBy getDiscoveredBy()

Gets the value of the discoveredBy property.

Returns:

possible object is DiscoveredBy

setDiscoveredBy

public void setDiscoveredBy(DiscoveredBy value)

Sets the value of the discoveredBy property.

Parameters:

value - allowed object is DiscoveredBy

getParamId

public String getParamId()

Gets the value of the paramId property.

Returns:

possible object is String

setParamId

public void setParamId(String value)

Sets the value of the paramId property.

Parameters:

value - allowed object is String

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getType

public ParameterKind getType()

Gets the value of the type property.

Returns:

possible object is ParameterKind

setType

public void setType(ParameterKind value)

Sets the value of the type property.

Parameters:

value - allowed object is ParameterKind

getInstantiationLevelId

public String getInstantiationLevelId()

Gets the value of the instantiationLevelId property.

Returns:

possible object is String

setInstantiationLevelId

public void setInstantiationLevelId(String value)

Sets the value of the instantiationLevelId property.

Parameters:

value - allowed object is String

getInstantiationLevelName

public String getInstantiationLevelName()

Gets the value of the instantiationLevelName property.

Returns:

possible object is String

setInstantiationLevelName

public void setInstantiationLevelName(String value)

Sets the value of the instantiationLevelName property.

Parameters:

value - allowed object is String

getInstantiationLevel

public HierarchyLevel getInstantiationLevel()

Gets the value of the instantiationLevel property.

Returns:

possible object is HierarchyLevel

setInstantiationLevel

public void setInstantiationLevel(HierarchyLevel value)

Sets the value of the instantiationLevel property.

Parameters:

value - allowed object is HierarchyLevel

getDefaultInstantiationLevelId

public String getDefaultInstantiationLevelId()

Gets the value of the defaultInstantiationLevelId property.

Returns:

possible object is String

setDefaultInstantiationLevelId

public void setDefaultInstantiationLevelId(String value)

Sets the value of the defaultInstantiationLevelId property.

Parameters:

value - allowed object is String

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

isIsArray

public boolean isIsArray()

Gets the value of the isArray property.

Returns:

possible object is Boolean

setIsArray

public void setIsArray(Boolean value)

Sets the value of the isArray property.

Parameters:

value - allowed object is Boolean

isMergeOverrides

public boolean isMergeOverrides()

Gets the value of the mergeOverrides property.

Returns:

possible object is Boolean

setMergeOverrides

public void setMergeOverrides(Boolean value)

Sets the value of the mergeOverrides property.

Parameters:

value - allowed object is Boolean

isRequired

public boolean isRequired()

Gets the value of the required property.

Returns:

possible object is Boolean

setRequired

public void setRequired(Boolean value)

Sets the value of the required property.

Parameters:

value - allowed object is Boolean

isHidden

public boolean isHidden()

Gets the value of the hidden property.

Returns:

possible object is Boolean

setHidden

public void setHidden(Boolean value)

Sets the value of the hidden property.

Parameters:

value - allowed object is Boolean

isReadOnly

public boolean isReadOnly()

Gets the value of the readOnly property.

Returns:

possible object is Boolean

setReadOnly

public void setReadOnly(Boolean value)

Sets the value of the readOnly property.

Parameters:

value - allowed object is Boolean

isAdvanced

public boolean isAdvanced()

Gets the value of the advanced property.

Returns:

possible object is Boolean

setAdvanced

public void setAdvanced(Boolean value)

Sets the value of the advanced property.

Parameters:

value - allowed object is Boolean

isRequiresRestart

public boolean isRequiresRestart()

Gets the value of the requiresRestart property.

Returns:

possible object is Boolean

setRequiresRestart

public void setRequiresRestart(Boolean value)

Sets the value of the requiresRestart property.

Parameters:

value - allowed object is Boolean

getUnit

public String getUnit()

Gets the value of the unit property.

Returns:

possible object is String

setUnit

public void setUnit(String value)

Sets the value of the unit property.

Parameters:

value - allowed object is String

getBase

public String getBase()

Gets the value of the base property.

Returns:

possible object is String

setBase

public void setBase(String value)

Sets the value of the base property.

Parameters:

value - allowed object is String

toString

public String toString()

Overrides:

toString in class Object

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                            StringBuilder buffer,
                            org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                  StringBuilder buffer,
                                  org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString

clone

public Object clone()

Overrides:

clone in class Object

copyTo

public Object copyTo(Object target)

Specified by:

copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo

copyTo

public Object copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                     Object target,
                     org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)

Specified by:

copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo

createNewInstance

public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb2_commons.lang.CopyTo

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals

equals

public boolean equals(Object object)

Overrides:

equals in class Object