public class

FieldDescription

extends Object
java.lang.Object
   ↳ com.clarizen.api.metadata.FieldDescription
Known Direct Subclasses

Class Overview

Java class for FieldDescription complex type.

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

 <complexType name="FieldDescription">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Type" type="{http://clarizen.com/api/metadata}FieldType" minOccurs="0"/>
         <element name="Calculated" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="CreateOnly" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Custom" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="DefaultValue" type="{http://www.w3.org/2001/XMLSchema}anyType" minOccurs="0"/>
         <element name="Internal" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Label" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Nullable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="PresentationType" type="{http://clarizen.com/api/metadata}PresentationType" minOccurs="0"/>
         <element name="System" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Updateable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Visible" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="DecimalPlaces" type="{http://www.w3.org/2001/XMLSchema}int"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Summary

Fields
protected boolean calculated
protected boolean createOnly
protected boolean custom
protected int decimalPlaces
protected Object defaultValue
protected boolean internal
protected String label
protected String name
protected boolean nullable
protected PresentationType presentationType
protected boolean system
protected FieldType type
protected boolean updateable
protected boolean visible
Public Constructors
FieldDescription()
Public Methods
int getDecimalPlaces()
Gets the value of the decimalPlaces property.
Object getDefaultValue()
Gets the value of the defaultValue property.
String getLabel()
Gets the value of the label property.
String getName()
Gets the value of the name property.
PresentationType getPresentationType()
Gets the value of the presentationType property.
FieldType getType()
Gets the value of the type property.
boolean isCalculated()
Gets the value of the calculated property.
boolean isCreateOnly()
Gets the value of the createOnly property.
boolean isCustom()
Gets the value of the custom property.
boolean isInternal()
Gets the value of the internal property.
boolean isNullable()
Gets the value of the nullable property.
boolean isSystem()
Gets the value of the system property.
boolean isUpdateable()
Gets the value of the updateable property.
boolean isVisible()
Gets the value of the visible property.
void setCalculated(boolean value)
Sets the value of the calculated property.
void setCreateOnly(boolean value)
Sets the value of the createOnly property.
void setCustom(boolean value)
Sets the value of the custom property.
void setDecimalPlaces(int value)
Sets the value of the decimalPlaces property.
void setDefaultValue(Object value)
Sets the value of the defaultValue property.
void setInternal(boolean value)
Sets the value of the internal property.
void setLabel(String value)
Sets the value of the label property.
void setName(String value)
Sets the value of the name property.
void setNullable(boolean value)
Sets the value of the nullable property.
void setPresentationType(PresentationType value)
Sets the value of the presentationType property.
void setSystem(boolean value)
Sets the value of the system property.
void setType(FieldType value)
Sets the value of the type property.
void setUpdateable(boolean value)
Sets the value of the updateable property.
void setVisible(boolean value)
Sets the value of the visible property.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected boolean calculated

protected boolean createOnly

protected boolean custom

protected int decimalPlaces

protected Object defaultValue

protected boolean internal

protected String label

protected String name

protected boolean nullable

protected PresentationType presentationType

protected boolean system

protected FieldType type

protected boolean updateable

protected boolean visible

Public Constructors

public FieldDescription ()

Public Methods

public int getDecimalPlaces ()

Gets the value of the decimalPlaces property.

public Object getDefaultValue ()

Gets the value of the defaultValue property.

Returns
  • possible object is Object

public String getLabel ()

Gets the value of the label property.

Returns
  • possible object is String

public String getName ()

Gets the value of the name property.

Returns
  • possible object is String

public PresentationType getPresentationType ()

Gets the value of the presentationType property.

Returns

public FieldType getType ()

Gets the value of the type property.

Returns

public boolean isCalculated ()

Gets the value of the calculated property.

public boolean isCreateOnly ()

Gets the value of the createOnly property.

public boolean isCustom ()

Gets the value of the custom property.

public boolean isInternal ()

Gets the value of the internal property.

public boolean isNullable ()

Gets the value of the nullable property.

public boolean isSystem ()

Gets the value of the system property.

public boolean isUpdateable ()

Gets the value of the updateable property.

public boolean isVisible ()

Gets the value of the visible property.

public void setCalculated (boolean value)

Sets the value of the calculated property.

Parameters
value

public void setCreateOnly (boolean value)

Sets the value of the createOnly property.

Parameters
value

public void setCustom (boolean value)

Sets the value of the custom property.

Parameters
value

public void setDecimalPlaces (int value)

Sets the value of the decimalPlaces property.

Parameters
value

public void setDefaultValue (Object value)

Sets the value of the defaultValue property.

Parameters
value Allowed object is Object

public void setInternal (boolean value)

Sets the value of the internal property.

Parameters
value

public void setLabel (String value)

Sets the value of the label property.

Parameters
value Allowed object is String

public void setName (String value)

Sets the value of the name property.

Parameters
value Allowed object is String

public void setNullable (boolean value)

Sets the value of the nullable property.

Parameters
value

public void setPresentationType (PresentationType value)

Sets the value of the presentationType property.

Parameters
value Allowed object is PresentationType

public void setSystem (boolean value)

Sets the value of the system property.

Parameters
value

public void setType (FieldType value)

Sets the value of the type property.

Parameters
value Allowed object is FieldType

public void setUpdateable (boolean value)

Sets the value of the updateable property.

Parameters
value

public void setVisible (boolean value)

Sets the value of the visible property.

Parameters
value