CustomField (sforce-tooling-api 35.0 API)

java.lang.Object
- com.sforce.soap.tooling.SObject
- - com.sforce.soap.tooling.CustomField

public class CustomField
extends SObject

Java class for CustomField complex type.

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

 <complexType name="CustomField">
   <complexContent>
     <extension base="{urn:tooling.soap.sforce.com}sObject">
       <sequence>
         <element name="CreatedBy" type="{urn:tooling.soap.sforce.com}User" minOccurs="0"/>
         <element name="CreatedById" type="{urn:tooling.soap.sforce.com}ID" minOccurs="0"/>
         <element name="CreatedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="DefaultValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="DeveloperName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="EntityDefinition" type="{urn:tooling.soap.sforce.com}EntityDefinition" minOccurs="0"/>
         <element name="EntityDefinitionId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FullName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InlineHelpText" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LastModifiedBy" type="{urn:tooling.soap.sforce.com}User" minOccurs="0"/>
         <element name="LastModifiedById" type="{urn:tooling.soap.sforce.com}ID" minOccurs="0"/>
         <element name="LastModifiedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Length" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ManageableState" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MaskChar" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MaskType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Metadata" type="{urn:metadata.tooling.soap.sforce.com}CustomField" minOccurs="0"/>
         <element name="NamespacePrefix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Precision" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="RelationshipLabel" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Scale" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="SummaryOperation" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TableEnumOrId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected User`	`createdBy`
`protected String`	`createdById`
`protected XMLGregorianCalendar`	`createdDate`
`protected String`	`defaultValue`
`protected String`	`description`
`protected String`	`developerName`
`protected EntityDefinition`	`entityDefinition`
`protected String`	`entityDefinitionId`
`protected String`	`fullName`
`protected String`	`inlineHelpText`
`protected User`	`lastModifiedBy`
`protected String`	`lastModifiedById`
`protected XMLGregorianCalendar`	`lastModifiedDate`
`protected Integer`	`length`
`protected String`	`manageableState`
`protected String`	`maskChar`
`protected String`	`maskType`
`protected CustomField`	`metadata`
`protected String`	`namespacePrefix`
`protected Integer`	`precision`
`protected String`	`relationshipLabel`
`protected Integer`	`scale`
`protected String`	`summaryOperation`
`protected String`	`tableEnumOrId`

Fields inherited from class com.sforce.soap.tooling.SObject
fieldsToNull, id

Constructor Summary

Constructors
Constructor and Description

CustomField()

Constructors
Constructor and Description
`CustomField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`User`	`getCreatedBy()` Gets the value of the createdBy property.
`String`	`getCreatedById()` Gets the value of the createdById property.
`XMLGregorianCalendar`	`getCreatedDate()` Gets the value of the createdDate property.
`String`	`getDefaultValue()` Gets the value of the defaultValue property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getDeveloperName()` Gets the value of the developerName property.
`EntityDefinition`	`getEntityDefinition()` Gets the value of the entityDefinition property.
`String`	`getEntityDefinitionId()` Gets the value of the entityDefinitionId property.
`String`	`getFullName()` Gets the value of the fullName property.
`String`	`getInlineHelpText()` Gets the value of the inlineHelpText property.
`User`	`getLastModifiedBy()` Gets the value of the lastModifiedBy property.
`String`	`getLastModifiedById()` Gets the value of the lastModifiedById property.
`XMLGregorianCalendar`	`getLastModifiedDate()` Gets the value of the lastModifiedDate property.
`Integer`	`getLength()` Gets the value of the length property.
`String`	`getManageableState()` Gets the value of the manageableState property.
`String`	`getMaskChar()` Gets the value of the maskChar property.
`String`	`getMaskType()` Gets the value of the maskType property.
`CustomField`	`getMetadata()` Gets the value of the metadata property.
`String`	`getNamespacePrefix()` Gets the value of the namespacePrefix property.
`Integer`	`getPrecision()` Gets the value of the precision property.
`String`	`getRelationshipLabel()` Gets the value of the relationshipLabel property.
`Integer`	`getScale()` Gets the value of the scale property.
`String`	`getSummaryOperation()` Gets the value of the summaryOperation property.
`String`	`getTableEnumOrId()` Gets the value of the tableEnumOrId property.
`void`	`setCreatedBy(User value)` Sets the value of the createdBy property.
`void`	`setCreatedById(String value)` Sets the value of the createdById property.
`void`	`setCreatedDate(XMLGregorianCalendar value)` Sets the value of the createdDate property.
`void`	`setDefaultValue(String value)` Sets the value of the defaultValue property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDeveloperName(String value)` Sets the value of the developerName property.
`void`	`setEntityDefinition(EntityDefinition value)` Sets the value of the entityDefinition property.
`void`	`setEntityDefinitionId(String value)` Sets the value of the entityDefinitionId property.
`void`	`setFullName(String value)` Sets the value of the fullName property.
`void`	`setInlineHelpText(String value)` Sets the value of the inlineHelpText property.
`void`	`setLastModifiedBy(User value)` Sets the value of the lastModifiedBy property.
`void`	`setLastModifiedById(String value)` Sets the value of the lastModifiedById property.
`void`	`setLastModifiedDate(XMLGregorianCalendar value)` Sets the value of the lastModifiedDate property.
`void`	`setLength(Integer value)` Sets the value of the length property.
`void`	`setManageableState(String value)` Sets the value of the manageableState property.
`void`	`setMaskChar(String value)` Sets the value of the maskChar property.
`void`	`setMaskType(String value)` Sets the value of the maskType property.
`void`	`setMetadata(CustomField value)` Sets the value of the metadata property.
`void`	`setNamespacePrefix(String value)` Sets the value of the namespacePrefix property.
`void`	`setPrecision(Integer value)` Sets the value of the precision property.
`void`	`setRelationshipLabel(String value)` Sets the value of the relationshipLabel property.
`void`	`setScale(Integer value)` Sets the value of the scale property.
`void`	`setSummaryOperation(String value)` Sets the value of the summaryOperation property.
`void`	`setTableEnumOrId(String value)` Sets the value of the tableEnumOrId property.

Methods inherited from class com.sforce.soap.tooling.SObject
getFieldsToNull, getId, setId

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

- Field Detail
  - createdBy
```
protected User createdBy
```
  - createdById
```
protected String createdById
```
  - createdDate
```
protected XMLGregorianCalendar createdDate
```
  - defaultValue
```
protected String defaultValue
```
  - description
```
protected String description
```
  - developerName
```
protected String developerName
```
  - entityDefinition
```
protected EntityDefinition entityDefinition
```
  - entityDefinitionId
```
protected String entityDefinitionId
```
  - fullName
```
protected String fullName
```
  - inlineHelpText
```
protected String inlineHelpText
```
  - lastModifiedBy
```
protected User lastModifiedBy
```
  - lastModifiedById
```
protected String lastModifiedById
```
  - lastModifiedDate
```
protected XMLGregorianCalendar lastModifiedDate
```
  - length
```
protected Integer length
```
  - manageableState
```
protected String manageableState
```
  - maskChar
```
protected String maskChar
```
  - maskType
```
protected String maskType
```
  - metadata
```
protected CustomField metadata
```
  - namespacePrefix
```
protected String namespacePrefix
```
  - precision
```
protected Integer precision
```
  - relationshipLabel
```
protected String relationshipLabel
```
  - scale
```
protected Integer scale
```
  - summaryOperation
```
protected String summaryOperation
```
  - tableEnumOrId
```
protected String tableEnumOrId
```
- Constructor Detail
  - CustomField
```
public CustomField()
```
- Method Detail
  - getCreatedBy
```
public User getCreatedBy()
```
    Gets the value of the createdBy property.
    
    Returns:
    
    possible object is User
  - setCreatedBy
```
public void setCreatedBy(User value)
```
    Sets the value of the createdBy property.
    
    Parameters:
    
    value - allowed object is User
  - getCreatedById
```
public String getCreatedById()
```
    Gets the value of the createdById property.
    
    Returns:
    
    possible object is String
  - setCreatedById
```
public void setCreatedById(String value)
```
    Sets the value of the createdById property.
    
    Parameters:
    
    value - allowed object is String
  - getCreatedDate
```
public XMLGregorianCalendar getCreatedDate()
```
    Gets the value of the createdDate property.
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setCreatedDate
```
public void setCreatedDate(XMLGregorianCalendar value)
```
    Sets the value of the createdDate property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - getDefaultValue
```
public String getDefaultValue()
```
    Gets the value of the defaultValue property.
    
    Returns:
    
    possible object is String
  - setDefaultValue
```
public void setDefaultValue(String value)
```
    Sets the value of the defaultValue 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
  - getDeveloperName
```
public String getDeveloperName()
```
    Gets the value of the developerName property.
    
    Returns:
    
    possible object is String
  - setDeveloperName
```
public void setDeveloperName(String value)
```
    Sets the value of the developerName property.
    
    Parameters:
    
    value - allowed object is String
  - getEntityDefinition
```
public EntityDefinition getEntityDefinition()
```
    Gets the value of the entityDefinition property.
    
    Returns:
    
    possible object is EntityDefinition
  - setEntityDefinition
```
public void setEntityDefinition(EntityDefinition value)
```
    Sets the value of the entityDefinition property.
    
    Parameters:
    
    value - allowed object is EntityDefinition
  - getEntityDefinitionId
```
public String getEntityDefinitionId()
```
    Gets the value of the entityDefinitionId property.
    
    Returns:
    
    possible object is String
  - setEntityDefinitionId
```
public void setEntityDefinitionId(String value)
```
    Sets the value of the entityDefinitionId property.
    
    Parameters:
    
    value - allowed object is String
  - getFullName
```
public String getFullName()
```
    Gets the value of the fullName property.
    
    Returns:
    
    possible object is String
  - setFullName
```
public void setFullName(String value)
```
    Sets the value of the fullName property.
    
    Parameters:
    
    value - allowed object is String
  - getInlineHelpText
```
public String getInlineHelpText()
```
    Gets the value of the inlineHelpText property.
    
    Returns:
    
    possible object is String
  - setInlineHelpText
```
public void setInlineHelpText(String value)
```
    Sets the value of the inlineHelpText property.
    
    Parameters:
    
    value - allowed object is String
  - getLastModifiedBy
```
public User getLastModifiedBy()
```
    Gets the value of the lastModifiedBy property.
    
    Returns:
    
    possible object is User
  - setLastModifiedBy
```
public void setLastModifiedBy(User value)
```
    Sets the value of the lastModifiedBy property.
    
    Parameters:
    
    value - allowed object is User
  - getLastModifiedById
```
public String getLastModifiedById()
```
    Gets the value of the lastModifiedById property.
    
    Returns:
    
    possible object is String
  - setLastModifiedById
```
public void setLastModifiedById(String value)
```
    Sets the value of the lastModifiedById property.
    
    Parameters:
    
    value - allowed object is String
  - getLastModifiedDate
```
public XMLGregorianCalendar getLastModifiedDate()
```
    Gets the value of the lastModifiedDate property.
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setLastModifiedDate
```
public void setLastModifiedDate(XMLGregorianCalendar value)
```
    Sets the value of the lastModifiedDate property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - getLength
```
public Integer getLength()
```
    Gets the value of the length property.
    
    Returns:
    
    possible object is Integer
  - setLength
```
public void setLength(Integer value)
```
    Sets the value of the length property.
    
    Parameters:
    
    value - allowed object is Integer
  - getManageableState
```
public String getManageableState()
```
    Gets the value of the manageableState property.
    
    Returns:
    
    possible object is String
  - setManageableState
```
public void setManageableState(String value)
```
    Sets the value of the manageableState property.
    
    Parameters:
    
    value - allowed object is String
  - getMaskChar
```
public String getMaskChar()
```
    Gets the value of the maskChar property.
    
    Returns:
    
    possible object is String
  - setMaskChar
```
public void setMaskChar(String value)
```
    Sets the value of the maskChar property.
    
    Parameters:
    
    value - allowed object is String
  - getMaskType
```
public String getMaskType()
```
    Gets the value of the maskType property.
    
    Returns:
    
    possible object is String
  - setMaskType
```
public void setMaskType(String value)
```
    Sets the value of the maskType property.
    
    Parameters:
    
    value - allowed object is String
  - getMetadata
```
public CustomField getMetadata()
```
    Gets the value of the metadata property.
    
    Returns:
    
    possible object is CustomField
  - setMetadata
```
public void setMetadata(CustomField value)
```
    Sets the value of the metadata property.
    
    Parameters:
    
    value - allowed object is CustomField
  - getNamespacePrefix
```
public String getNamespacePrefix()
```
    Gets the value of the namespacePrefix property.
    
    Returns:
    
    possible object is String
  - setNamespacePrefix
```
public void setNamespacePrefix(String value)
```
    Sets the value of the namespacePrefix property.
    
    Parameters:
    
    value - allowed object is String
  - getPrecision
```
public Integer getPrecision()
```
    Gets the value of the precision property.
    
    Returns:
    
    possible object is Integer
  - setPrecision
```
public void setPrecision(Integer value)
```
    Sets the value of the precision property.
    
    Parameters:
    
    value - allowed object is Integer
  - getRelationshipLabel
```
public String getRelationshipLabel()
```
    Gets the value of the relationshipLabel property.
    
    Returns:
    
    possible object is String
  - setRelationshipLabel
```
public void setRelationshipLabel(String value)
```
    Sets the value of the relationshipLabel property.
    
    Parameters:
    
    value - allowed object is String
  - getScale
```
public Integer getScale()
```
    Gets the value of the scale property.
    
    Returns:
    
    possible object is Integer
  - setScale
```
public void setScale(Integer value)
```
    Sets the value of the scale property.
    
    Parameters:
    
    value - allowed object is Integer
  - getSummaryOperation
```
public String getSummaryOperation()
```
    Gets the value of the summaryOperation property.
    
    Returns:
    
    possible object is String
  - setSummaryOperation
```
public void setSummaryOperation(String value)
```
    Sets the value of the summaryOperation property.
    
    Parameters:
    
    value - allowed object is String
  - getTableEnumOrId
```
public String getTableEnumOrId()
```
    Gets the value of the tableEnumOrId property.
    
    Returns:
    
    possible object is String
  - setTableEnumOrId
```
public void setTableEnumOrId(String value)
```
    Sets the value of the tableEnumOrId property.
    
    Parameters:
    
    value - allowed object is String

Class CustomField

Field Summary

Fields inherited from class com.sforce.soap.tooling.SObject

Constructor Summary

Method Summary

Methods inherited from class com.sforce.soap.tooling.SObject

Methods inherited from class java.lang.Object

Field Detail

createdBy

createdById

createdDate

defaultValue

description

developerName

entityDefinition

entityDefinitionId

fullName

inlineHelpText

lastModifiedBy

lastModifiedById

lastModifiedDate

length

manageableState

maskChar

maskType

metadata

namespacePrefix

precision

relationshipLabel

scale

summaryOperation

tableEnumOrId

Constructor Detail

CustomField

Method Detail

getCreatedBy

setCreatedBy

getCreatedById

setCreatedById

getCreatedDate

setCreatedDate

getDefaultValue

setDefaultValue

getDescription

setDescription

getDeveloperName

setDeveloperName

getEntityDefinition

setEntityDefinition

getEntityDefinitionId

setEntityDefinitionId

getFullName

setFullName

getInlineHelpText

setInlineHelpText

getLastModifiedBy

setLastModifiedBy

getLastModifiedById

setLastModifiedById

getLastModifiedDate

setLastModifiedDate

getLength

setLength

getManageableState

setManageableState

getMaskChar

setMaskChar

getMaskType

setMaskType

getMetadata

setMetadata

getNamespacePrefix

setNamespacePrefix

getPrecision

setPrecision

getRelationshipLabel

setRelationshipLabel

getScale

setScale

getSummaryOperation