Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sforce.soap.partner
Class Field

java.lang.Object
  extended by com.sforce.soap.partner.Field

public class Field
extends java.lang.Object

Java class for Field complex type.

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

 <complexType name="Field">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="autoNumber" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="byteLength" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="calculated" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="calculatedFormula" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="caseSensitive" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="controllerName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="createable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="custom" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="defaultValueFormula" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="defaultedOnCreate" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="dependentPicklist" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="deprecatedAndHidden" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="digits" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="externalId" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="filterable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="htmlFormatted" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="idLookup" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="inlineHelpText" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="label" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="length" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="nameField" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="namePointing" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="nillable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="picklistValues" type="{urn:partner.soap.sforce.com}PicklistEntry" maxOccurs="unbounded" minOccurs="0"/>
         <element name="precision" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="referenceTo" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="relationshipName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="relationshipOrder" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="restrictedPicklist" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="scale" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="soapType" type="{urn:partner.soap.sforce.com}soapType"/>
         <element name="sortable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="type" type="{urn:partner.soap.sforce.com}fieldType"/>
         <element name="unique" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="updateable" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="writeRequiresMasterRead" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  boolean autoNumber
           
protected  int byteLength
           
protected  boolean calculated
           
protected  java.lang.String calculatedFormula
           
protected  boolean caseSensitive
           
protected  java.lang.String controllerName
           
protected  boolean createable
           
protected  boolean custom
           
protected  boolean defaultedOnCreate
           
protected  java.lang.String defaultValueFormula
           
protected  java.lang.Boolean dependentPicklist
           
protected  boolean deprecatedAndHidden
           
protected  int digits
           
protected  java.lang.Boolean externalId
           
protected  boolean filterable
           
protected  java.lang.Boolean htmlFormatted
           
protected  boolean idLookup
           
protected  java.lang.String inlineHelpText
           
protected  java.lang.String label
           
protected  int length
           
protected  java.lang.String name
           
protected  boolean nameField
           
protected  java.lang.Boolean namePointing
           
protected  boolean nillable
           
protected  java.util.List<PicklistEntry> picklistValues
           
protected  int precision
           
protected  java.util.List<java.lang.String> referenceTo
           
protected  java.lang.String relationshipName
           
protected  java.lang.Integer relationshipOrder
           
protected  boolean restrictedPicklist
           
protected  int scale
           
protected  SoapType soapType
           
protected  java.lang.Boolean sortable
           
protected  FieldType type
           
protected  boolean unique
           
protected  boolean updateable
           
protected  java.lang.Boolean writeRequiresMasterRead
           
 
Constructor Summary
Field()
           
 
Method Summary
 int getByteLength()
          Gets the value of the byteLength property.
 java.lang.String getCalculatedFormula()
          Gets the value of the calculatedFormula property.
 java.lang.String getControllerName()
          Gets the value of the controllerName property.
 java.lang.String getDefaultValueFormula()
          Gets the value of the defaultValueFormula property.
 int getDigits()
          Gets the value of the digits property.
 java.lang.String getInlineHelpText()
          Gets the value of the inlineHelpText property.
 java.lang.String getLabel()
          Gets the value of the label property.
 int getLength()
          Gets the value of the length property.
 java.lang.String getName()
          Gets the value of the name property.
 java.util.List<PicklistEntry> getPicklistValues()
          Gets the value of the picklistValues property.
 int getPrecision()
          Gets the value of the precision property.
 java.util.List<java.lang.String> getReferenceTo()
          Gets the value of the referenceTo property.
 java.lang.String getRelationshipName()
          Gets the value of the relationshipName property.
 java.lang.Integer getRelationshipOrder()
          Gets the value of the relationshipOrder property.
 int getScale()
          Gets the value of the scale property.
 SoapType getSoapType()
          Gets the value of the soapType property.
 FieldType getType()
          Gets the value of the type property.
 boolean isAutoNumber()
          Gets the value of the autoNumber property.
 boolean isCalculated()
          Gets the value of the calculated property.
 boolean isCaseSensitive()
          Gets the value of the caseSensitive property.
 boolean isCreateable()
          Gets the value of the createable property.
 boolean isCustom()
          Gets the value of the custom property.
 boolean isDefaultedOnCreate()
          Gets the value of the defaultedOnCreate property.
 java.lang.Boolean isDependentPicklist()
          Gets the value of the dependentPicklist property.
 boolean isDeprecatedAndHidden()
          Gets the value of the deprecatedAndHidden property.
 java.lang.Boolean isExternalId()
          Gets the value of the externalId property.
 boolean isFilterable()
          Gets the value of the filterable property.
 java.lang.Boolean isHtmlFormatted()
          Gets the value of the htmlFormatted property.
 boolean isIdLookup()
          Gets the value of the idLookup property.
 boolean isNameField()
          Gets the value of the nameField property.
 java.lang.Boolean isNamePointing()
          Gets the value of the namePointing property.
 boolean isNillable()
          Gets the value of the nillable property.
 boolean isRestrictedPicklist()
          Gets the value of the restrictedPicklist property.
 java.lang.Boolean isSortable()
          Gets the value of the sortable property.
 boolean isUnique()
          Gets the value of the unique property.
 boolean isUpdateable()
          Gets the value of the updateable property.
 java.lang.Boolean isWriteRequiresMasterRead()
          Gets the value of the writeRequiresMasterRead property.
 void setAutoNumber(boolean value)
          Sets the value of the autoNumber property.
 void setByteLength(int value)
          Sets the value of the byteLength property.
 void setCalculated(boolean value)
          Sets the value of the calculated property.
 void setCalculatedFormula(java.lang.String value)
          Sets the value of the calculatedFormula property.
 void setCaseSensitive(boolean value)
          Sets the value of the caseSensitive property.
 void setControllerName(java.lang.String value)
          Sets the value of the controllerName property.
 void setCreateable(boolean value)
          Sets the value of the createable property.
 void setCustom(boolean value)
          Sets the value of the custom property.
 void setDefaultedOnCreate(boolean value)
          Sets the value of the defaultedOnCreate property.
 void setDefaultValueFormula(java.lang.String value)
          Sets the value of the defaultValueFormula property.
 void setDependentPicklist(java.lang.Boolean value)
          Sets the value of the dependentPicklist property.
 void setDeprecatedAndHidden(boolean value)
          Sets the value of the deprecatedAndHidden property.
 void setDigits(int value)
          Sets the value of the digits property.
 void setExternalId(java.lang.Boolean value)
          Sets the value of the externalId property.
 void setFilterable(boolean value)
          Sets the value of the filterable property.
 void setHtmlFormatted(java.lang.Boolean value)
          Sets the value of the htmlFormatted property.
 void setIdLookup(boolean value)
          Sets the value of the idLookup property.
 void setInlineHelpText(java.lang.String value)
          Sets the value of the inlineHelpText property.
 void setLabel(java.lang.String value)
          Sets the value of the label property.
 void setLength(int value)
          Sets the value of the length property.
 void setName(java.lang.String value)
          Sets the value of the name property.
 void setNameField(boolean value)
          Sets the value of the nameField property.
 void setNamePointing(java.lang.Boolean value)
          Sets the value of the namePointing property.
 void setNillable(boolean value)
          Sets the value of the nillable property.
 void setPrecision(int value)
          Sets the value of the precision property.
 void setRelationshipName(java.lang.String value)
          Sets the value of the relationshipName property.
 void setRelationshipOrder(java.lang.Integer value)
          Sets the value of the relationshipOrder property.
 void setRestrictedPicklist(boolean value)
          Sets the value of the restrictedPicklist property.
 void setScale(int value)
          Sets the value of the scale property.
 void setSoapType(SoapType value)
          Sets the value of the soapType property.
 void setSortable(java.lang.Boolean value)
          Sets the value of the sortable property.
 void setType(FieldType value)
          Sets the value of the type property.
 void setUnique(boolean value)
          Sets the value of the unique property.
 void setUpdateable(boolean value)
          Sets the value of the updateable property.
 void setWriteRequiresMasterRead(java.lang.Boolean value)
          Sets the value of the writeRequiresMasterRead property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

autoNumber

protected boolean autoNumber

byteLength

protected int byteLength

calculated

protected boolean calculated

calculatedFormula

protected java.lang.String calculatedFormula

caseSensitive

protected boolean caseSensitive

controllerName

protected java.lang.String controllerName

createable

protected boolean createable

custom

protected boolean custom

defaultValueFormula

protected java.lang.String defaultValueFormula

defaultedOnCreate

protected boolean defaultedOnCreate

dependentPicklist

protected java.lang.Boolean dependentPicklist

deprecatedAndHidden

protected boolean deprecatedAndHidden

digits

protected int digits

externalId

protected java.lang.Boolean externalId

filterable

protected boolean filterable

htmlFormatted

protected java.lang.Boolean htmlFormatted

idLookup

protected boolean idLookup

inlineHelpText

protected java.lang.String inlineHelpText

label

protected java.lang.String label

length

protected int length

name

protected java.lang.String name

nameField

protected boolean nameField

namePointing

protected java.lang.Boolean namePointing

nillable

protected boolean nillable

picklistValues

protected java.util.List<PicklistEntry> picklistValues

precision

protected int precision

referenceTo

protected java.util.List<java.lang.String> referenceTo

relationshipName

protected java.lang.String relationshipName

relationshipOrder

protected java.lang.Integer relationshipOrder

restrictedPicklist

protected boolean restrictedPicklist

scale

protected int scale

soapType

protected SoapType soapType

sortable

protected java.lang.Boolean sortable

type

protected FieldType type

unique

protected boolean unique

updateable

protected boolean updateable

writeRequiresMasterRead

protected java.lang.Boolean writeRequiresMasterRead
Constructor Detail

Field

public Field()
Method Detail

isAutoNumber

public boolean isAutoNumber()
Gets the value of the autoNumber property.

setAutoNumber

public void setAutoNumber(boolean value)
Sets the value of the autoNumber property.

getByteLength

public int getByteLength()
Gets the value of the byteLength property.

setByteLength

public void setByteLength(int value)
Sets the value of the byteLength property.

isCalculated

public boolean isCalculated()
Gets the value of the calculated property.

setCalculated

public void setCalculated(boolean value)
Sets the value of the calculated property.

getCalculatedFormula

public java.lang.String getCalculatedFormula()
Gets the value of the calculatedFormula property.

Returns:
possible object is String

setCalculatedFormula

public void setCalculatedFormula(java.lang.String value)
Sets the value of the calculatedFormula property.

Parameters:
value - allowed object is String

isCaseSensitive

public boolean isCaseSensitive()
Gets the value of the caseSensitive property.

setCaseSensitive

public void setCaseSensitive(boolean value)
Sets the value of the caseSensitive property.

getControllerName

public java.lang.String getControllerName()
Gets the value of the controllerName property.

Returns:
possible object is String

setControllerName

public void setControllerName(java.lang.String value)
Sets the value of the controllerName property.

Parameters:
value - allowed object is String

isCreateable

public boolean isCreateable()
Gets the value of the createable property.

setCreateable

public void setCreateable(boolean value)
Sets the value of the createable property.

isCustom

public boolean isCustom()
Gets the value of the custom property.

setCustom

public void setCustom(boolean value)
Sets the value of the custom property.

getDefaultValueFormula

public java.lang.String getDefaultValueFormula()
Gets the value of the defaultValueFormula property.

Returns:
possible object is String

setDefaultValueFormula

public void setDefaultValueFormula(java.lang.String value)
Sets the value of the defaultValueFormula property.

Parameters:
value - allowed object is String

isDefaultedOnCreate

public boolean isDefaultedOnCreate()
Gets the value of the defaultedOnCreate property.

setDefaultedOnCreate

public void setDefaultedOnCreate(boolean value)
Sets the value of the defaultedOnCreate property.

isDependentPicklist

public java.lang.Boolean isDependentPicklist()
Gets the value of the dependentPicklist property.

Returns:
possible object is Boolean

setDependentPicklist

public void setDependentPicklist(java.lang.Boolean value)
Sets the value of the dependentPicklist property.

Parameters:
value - allowed object is Boolean

isDeprecatedAndHidden

public boolean isDeprecatedAndHidden()
Gets the value of the deprecatedAndHidden property.

setDeprecatedAndHidden

public void setDeprecatedAndHidden(boolean value)
Sets the value of the deprecatedAndHidden property.

getDigits

public int getDigits()
Gets the value of the digits property.

setDigits

public void setDigits(int value)
Sets the value of the digits property.

isExternalId

public java.lang.Boolean isExternalId()
Gets the value of the externalId property.

Returns:
possible object is Boolean

setExternalId

public void setExternalId(java.lang.Boolean value)
Sets the value of the externalId property.

Parameters:
value - allowed object is Boolean

isFilterable

public boolean isFilterable()
Gets the value of the filterable property.

setFilterable

public void setFilterable(boolean value)
Sets the value of the filterable property.

isHtmlFormatted

public java.lang.Boolean isHtmlFormatted()
Gets the value of the htmlFormatted property.

Returns:
possible object is Boolean

setHtmlFormatted

public void setHtmlFormatted(java.lang.Boolean value)
Sets the value of the htmlFormatted property.

Parameters:
value - allowed object is Boolean

isIdLookup

public boolean isIdLookup()
Gets the value of the idLookup property.

setIdLookup

public void setIdLookup(boolean value)
Sets the value of the idLookup property.

getInlineHelpText

public java.lang.String getInlineHelpText()
Gets the value of the inlineHelpText property.

Returns:
possible object is String

setInlineHelpText

public void setInlineHelpText(java.lang.String value)
Sets the value of the inlineHelpText property.

Parameters:
value - allowed object is String

getLabel

public java.lang.String getLabel()
Gets the value of the label property.

Returns:
possible object is String

setLabel

public void setLabel(java.lang.String value)
Sets the value of the label property.

Parameters:
value - allowed object is String

getLength

public int getLength()
Gets the value of the length property.

setLength

public void setLength(int value)
Sets the value of the length property.

getName

public java.lang.String getName()
Gets the value of the name property.

Returns:
possible object is String

setName

public void setName(java.lang.String value)
Sets the value of the name property.

Parameters:
value - allowed object is String

isNameField

public boolean isNameField()
Gets the value of the nameField property.

setNameField

public void setNameField(boolean value)
Sets the value of the nameField property.

isNamePointing

public java.lang.Boolean isNamePointing()
Gets the value of the namePointing property.

Returns:
possible object is Boolean

setNamePointing

public void setNamePointing(java.lang.Boolean value)
Sets the value of the namePointing property.

Parameters:
value - allowed object is Boolean

isNillable

public boolean isNillable()
Gets the value of the nillable property.

setNillable

public void setNillable(boolean value)
Sets the value of the nillable property.

getPicklistValues

public java.util.List<PicklistEntry> getPicklistValues()
Gets the value of the picklistValues 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 picklistValues property.

For example, to add a new item, do as follows: 

    getPicklistValues().add(newItem);

Objects of the following type(s) are allowed in the list PicklistEntry

getPrecision

public int getPrecision()
Gets the value of the precision property.

setPrecision

public void setPrecision(int value)
Sets the value of the precision property.

getReferenceTo

public java.util.List<java.lang.String> getReferenceTo()
Gets the value of the referenceTo 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 referenceTo property.

For example, to add a new item, do as follows: 

    getReferenceTo().add(newItem);

Objects of the following type(s) are allowed in the list String

getRelationshipName

public java.lang.String getRelationshipName()
Gets the value of the relationshipName property.

Returns:
possible object is String

setRelationshipName

public void setRelationshipName(java.lang.String value)
Sets the value of the relationshipName property.

Parameters:
value - allowed object is String

getRelationshipOrder

public java.lang.Integer getRelationshipOrder()
Gets the value of the relationshipOrder property.

Returns:
possible object is Integer

setRelationshipOrder

public void setRelationshipOrder(java.lang.Integer value)
Sets the value of the relationshipOrder property.

Parameters:
value - allowed object is Integer

isRestrictedPicklist

public boolean isRestrictedPicklist()
Gets the value of the restrictedPicklist property.

setRestrictedPicklist

public void setRestrictedPicklist(boolean value)
Sets the value of the restrictedPicklist property.

getScale

public int getScale()
Gets the value of the scale property.

setScale

public void setScale(int value)
Sets the value of the scale property.

getSoapType

public SoapType getSoapType()
Gets the value of the soapType property.

Returns:
possible object is SoapType

setSoapType

public void setSoapType(SoapType value)
Sets the value of the soapType property.

Parameters:
value - allowed object is SoapType

isSortable

public java.lang.Boolean isSortable()
Gets the value of the sortable property.

Returns:
possible object is Boolean

setSortable

public void setSortable(java.lang.Boolean value)
Sets the value of the sortable property.

Parameters:
value - allowed object is Boolean

getType

public FieldType getType()
Gets the value of the type property.

Returns:
possible object is FieldType

setType

public void setType(FieldType value)
Sets the value of the type property.

Parameters:
value - allowed object is FieldType

isUnique

public boolean isUnique()
Gets the value of the unique property.

setUnique

public void setUnique(boolean value)
Sets the value of the unique property.

isUpdateable

public boolean isUpdateable()
Gets the value of the updateable property.

setUpdateable

public void setUpdateable(boolean value)
Sets the value of the updateable property.

isWriteRequiresMasterRead

public java.lang.Boolean isWriteRequiresMasterRead()
Gets the value of the writeRequiresMasterRead property.

Returns:
possible object is Boolean

setWriteRequiresMasterRead

public void setWriteRequiresMasterRead(java.lang.Boolean value)
Sets the value of the writeRequiresMasterRead property.

Parameters:
value - allowed object is Boolean
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010. All Rights Reserved.