CustomField (force-metadata-api 34.0 API)

java.lang.Object
- com.sforce.soap.metadata.Metadata
- - com.sforce.soap.metadata.CustomField

All Implemented Interfaces:

XMLizable
```
public class CustomField
extends Metadata
```
Generated by ComplexTypeCodeGenerator.java. Please do not edit.

Constructor Summary

Constructors
Constructor and Description

CustomField()
Constructor

Constructors
Constructor and Description
`CustomField()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getCaseSensitive()`
`String`	`getCustomDataType()`
`String`	`getDefaultValue()`
`DeleteConstraint`	`getDeleteConstraint()`
`boolean`	`getDeprecated()`
`String`	`getDescription()`
`String`	`getDisplayFormat()`
`boolean`	`getEncrypted()`
`boolean`	`getEscapeMarkup()`
`String`	`getExternalDeveloperName()`
`boolean`	`getExternalId()`
`String`	`getFormula()`
`TreatBlanksAs`	`getFormulaTreatBlanksAs()`
`String`	`getInlineHelpText()`
`boolean`	`getIsFilteringDisabled()`
`boolean`	`getIsNameField()`
`boolean`	`getIsSortingDisabled()`
`String`	`getLabel()`
`int`	`getLength()`
`LookupFilter`	`getLookupFilter()`
`EncryptedFieldMaskChar`	`getMaskChar()`
`EncryptedFieldMaskType`	`getMaskType()`
`Picklist`	`getPicklist()`
`boolean`	`getPopulateExistingRows()`
`int`	`getPrecision()`
`String`	`getReferenceTargetField()`
`String`	`getReferenceTo()`
`String`	`getRelationshipLabel()`
`String`	`getRelationshipName()`
`int`	`getRelationshipOrder()`
`boolean`	`getReparentableMasterDetail()`
`boolean`	`getRequired()`
`boolean`	`getRestrictedAdminField()`
`int`	`getScale()`
`int`	`getStartingNumber()`
`boolean`	`getStripMarkup()`
`String`	`getSummarizedField()`
`FilterItem[]`	`getSummaryFilterItems()`
`String`	`getSummaryForeignKey()`
`SummaryOperations`	`getSummaryOperation()`
`boolean`	`getTrackFeedHistory()`
`boolean`	`getTrackHistory()`
`boolean`	`getTrackTrending()`
`FieldType`	`getType()`
`boolean`	`getUnique()`
`int`	`getVisibleLines()`
`boolean`	`getWriteRequiresMasterRead()`
`boolean`	`isCaseSensitive()`
`boolean`	`isDeprecated()`
`boolean`	`isEncrypted()`
`boolean`	`isEscapeMarkup()`
`boolean`	`isExternalId()`
`boolean`	`isIsFilteringDisabled()`
`boolean`	`isIsNameField()`
`boolean`	`isIsSortingDisabled()`
`boolean`	`isPopulateExistingRows()`
`boolean`	`isReparentableMasterDetail()`
`boolean`	`isRequired()`
`boolean`	`isRestrictedAdminField()`
`boolean`	`isStripMarkup()`
`boolean`	`isTrackFeedHistory()`
`boolean`	`isTrackHistory()`
`boolean`	`isTrackTrending()`
`boolean`	`isUnique()`
`boolean`	`isWriteRequiresMasterRead()`
`void`	`load(XmlInputStream __in, TypeMapper __typeMapper)`
`protected void`	`loadFields(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setCaseSensitive(boolean caseSensitive)`
`void`	`setCustomDataType(String customDataType)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setDeleteConstraint(DeleteConstraint deleteConstraint)`
`void`	`setDeprecated(boolean deprecated)`
`void`	`setDescription(String description)`
`void`	`setDisplayFormat(String displayFormat)`
`void`	`setEncrypted(boolean encrypted)`
`void`	`setEscapeMarkup(boolean escapeMarkup)`
`void`	`setExternalDeveloperName(String externalDeveloperName)`
`void`	`setExternalId(boolean externalId)`
`void`	`setFormula(String formula)`
`void`	`setFormulaTreatBlanksAs(TreatBlanksAs formulaTreatBlanksAs)`
`void`	`setInlineHelpText(String inlineHelpText)`
`void`	`setIsFilteringDisabled(boolean isFilteringDisabled)`
`void`	`setIsNameField(boolean isNameField)`
`void`	`setIsSortingDisabled(boolean isSortingDisabled)`
`void`	`setLabel(String label)`
`void`	`setLength(int length)`
`void`	`setLookupFilter(LookupFilter lookupFilter)`
`void`	`setMaskChar(EncryptedFieldMaskChar maskChar)`
`void`	`setMaskType(EncryptedFieldMaskType maskType)`
`void`	`setPicklist(Picklist picklist)`
`void`	`setPopulateExistingRows(boolean populateExistingRows)`
`void`	`setPrecision(int precision)`
`void`	`setReferenceTargetField(String referenceTargetField)`
`void`	`setReferenceTo(String referenceTo)`
`void`	`setRelationshipLabel(String relationshipLabel)`
`void`	`setRelationshipName(String relationshipName)`
`void`	`setRelationshipOrder(int relationshipOrder)`
`void`	`setReparentableMasterDetail(boolean reparentableMasterDetail)`
`void`	`setRequired(boolean required)`
`void`	`setRestrictedAdminField(boolean restrictedAdminField)`
`void`	`setScale(int scale)`
`void`	`setStartingNumber(int startingNumber)`
`void`	`setStripMarkup(boolean stripMarkup)`
`void`	`setSummarizedField(String summarizedField)`
`void`	`setSummaryFilterItems(FilterItem[] summaryFilterItems)`
`void`	`setSummaryForeignKey(String summaryForeignKey)`
`void`	`setSummaryOperation(SummaryOperations summaryOperation)`
`void`	`setTrackFeedHistory(boolean trackFeedHistory)`
`void`	`setTrackHistory(boolean trackHistory)`
`void`	`setTrackTrending(boolean trackTrending)`
`void`	`setType(FieldType type)`
`void`	`setUnique(boolean unique)`
`void`	`setVisibleLines(int visibleLines)`
`void`	`setWriteRequiresMasterRead(boolean writeRequiresMasterRead)`
`String`	`toString()`
`void`	`write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper)`
`protected void`	`writeFields(XmlOutputStream __out, TypeMapper __typeMapper)`

Methods inherited from class com.sforce.soap.metadata.Metadata
getFullName, setFullName

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

Constructor Detail
- CustomField
```
public CustomField()
```
  Constructor

Method Detail

getCaseSensitive
```
public boolean getCaseSensitive()
```

isCaseSensitive
```
public boolean isCaseSensitive()
```

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getCustomDataType
```
public String getCustomDataType()
```

setCustomDataType

public void setCustomDataType(String customDataType)

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

getDeleteConstraint

public DeleteConstraint getDeleteConstraint()

setDeleteConstraint

public void setDeleteConstraint(DeleteConstraint deleteConstraint)

getDeprecated
```
public boolean getDeprecated()
```

isDeprecated
```
public boolean isDeprecated()
```

setDeprecated

public void setDeprecated(boolean deprecated)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getDisplayFormat
```
public String getDisplayFormat()
```

setDisplayFormat

public void setDisplayFormat(String displayFormat)

getEncrypted
```
public boolean getEncrypted()
```

isEncrypted
```
public boolean isEncrypted()
```

setEncrypted

public void setEncrypted(boolean encrypted)

getEscapeMarkup
```
public boolean getEscapeMarkup()
```

isEscapeMarkup
```
public boolean isEscapeMarkup()
```

setEscapeMarkup

public void setEscapeMarkup(boolean escapeMarkup)

getExternalDeveloperName

public String getExternalDeveloperName()

setExternalDeveloperName

public void setExternalDeveloperName(String externalDeveloperName)

getExternalId
```
public boolean getExternalId()
```

isExternalId
```
public boolean isExternalId()
```

setExternalId

public void setExternalId(boolean externalId)

getFormula
```
public String getFormula()
```

setFormula

public void setFormula(String formula)

getFormulaTreatBlanksAs

public TreatBlanksAs getFormulaTreatBlanksAs()

setFormulaTreatBlanksAs

public void setFormulaTreatBlanksAs(TreatBlanksAs formulaTreatBlanksAs)

getInlineHelpText
```
public String getInlineHelpText()
```

setInlineHelpText

public void setInlineHelpText(String inlineHelpText)

getIsFilteringDisabled

public boolean getIsFilteringDisabled()

isIsFilteringDisabled

public boolean isIsFilteringDisabled()

setIsFilteringDisabled

public void setIsFilteringDisabled(boolean isFilteringDisabled)

getIsNameField
```
public boolean getIsNameField()
```

isIsNameField
```
public boolean isIsNameField()
```

setIsNameField

public void setIsNameField(boolean isNameField)

getIsSortingDisabled
```
public boolean getIsSortingDisabled()
```

isIsSortingDisabled
```
public boolean isIsSortingDisabled()
```

setIsSortingDisabled

public void setIsSortingDisabled(boolean isSortingDisabled)

getLabel
```
public String getLabel()
```

setLabel
```
public void setLabel(String label)
```

getLength
```
public int getLength()
```

setLength
```
public void setLength(int length)
```

getLookupFilter
```
public LookupFilter getLookupFilter()
```

setLookupFilter

public void setLookupFilter(LookupFilter lookupFilter)

getMaskChar

public EncryptedFieldMaskChar getMaskChar()

setMaskChar

public void setMaskChar(EncryptedFieldMaskChar maskChar)

getMaskType

public EncryptedFieldMaskType getMaskType()

setMaskType

public void setMaskType(EncryptedFieldMaskType maskType)

getPicklist
```
public Picklist getPicklist()
```

setPicklist

public void setPicklist(Picklist picklist)

getPopulateExistingRows

public boolean getPopulateExistingRows()

isPopulateExistingRows

public boolean isPopulateExistingRows()

setPopulateExistingRows

public void setPopulateExistingRows(boolean populateExistingRows)

getPrecision
```
public int getPrecision()
```

setPrecision

public void setPrecision(int precision)

getReferenceTargetField

public String getReferenceTargetField()

setReferenceTargetField

public void setReferenceTargetField(String referenceTargetField)

getReferenceTo
```
public String getReferenceTo()
```

setReferenceTo

public void setReferenceTo(String referenceTo)

getRelationshipLabel
```
public String getRelationshipLabel()
```

setRelationshipLabel

public void setRelationshipLabel(String relationshipLabel)

getRelationshipName
```
public String getRelationshipName()
```

setRelationshipName

public void setRelationshipName(String relationshipName)

getRelationshipOrder
```
public int getRelationshipOrder()
```

setRelationshipOrder

public void setRelationshipOrder(int relationshipOrder)

getReparentableMasterDetail

public boolean getReparentableMasterDetail()

isReparentableMasterDetail

public boolean isReparentableMasterDetail()

setReparentableMasterDetail

public void setReparentableMasterDetail(boolean reparentableMasterDetail)

getRequired
```
public boolean getRequired()
```

isRequired
```
public boolean isRequired()
```

setRequired

public void setRequired(boolean required)

getRestrictedAdminField

public boolean getRestrictedAdminField()

isRestrictedAdminField

public boolean isRestrictedAdminField()

setRestrictedAdminField

public void setRestrictedAdminField(boolean restrictedAdminField)

getScale
```
public int getScale()
```

setScale
```
public void setScale(int scale)
```

getStartingNumber
```
public int getStartingNumber()
```

setStartingNumber

public void setStartingNumber(int startingNumber)

getStripMarkup
```
public boolean getStripMarkup()
```

isStripMarkup
```
public boolean isStripMarkup()
```

setStripMarkup

public void setStripMarkup(boolean stripMarkup)

getSummarizedField
```
public String getSummarizedField()
```

setSummarizedField

public void setSummarizedField(String summarizedField)

getSummaryFilterItems

public FilterItem[] getSummaryFilterItems()

setSummaryFilterItems

public void setSummaryFilterItems(FilterItem[] summaryFilterItems)

getSummaryForeignKey
```
public String getSummaryForeignKey()
```

setSummaryForeignKey

public void setSummaryForeignKey(String summaryForeignKey)

getSummaryOperation

public SummaryOperations getSummaryOperation()

setSummaryOperation

public void setSummaryOperation(SummaryOperations summaryOperation)

getTrackFeedHistory
```
public boolean getTrackFeedHistory()
```

isTrackFeedHistory
```
public boolean isTrackFeedHistory()
```

setTrackFeedHistory

public void setTrackFeedHistory(boolean trackFeedHistory)

getTrackHistory
```
public boolean getTrackHistory()
```

isTrackHistory
```
public boolean isTrackHistory()
```

setTrackHistory

public void setTrackHistory(boolean trackHistory)

getTrackTrending
```
public boolean getTrackTrending()
```

isTrackTrending
```
public boolean isTrackTrending()
```

setTrackTrending

public void setTrackTrending(boolean trackTrending)

getType
```
public FieldType getType()
```

setType
```
public void setType(FieldType type)
```

getUnique
```
public boolean getUnique()
```

isUnique
```
public boolean isUnique()
```

setUnique

public void setUnique(boolean unique)

getVisibleLines
```
public int getVisibleLines()
```

setVisibleLines

public void setVisibleLines(int visibleLines)

getWriteRequiresMasterRead

public boolean getWriteRequiresMasterRead()

isWriteRequiresMasterRead

public boolean isWriteRequiresMasterRead()

setWriteRequiresMasterRead

public void setWriteRequiresMasterRead(boolean writeRequiresMasterRead)

write

public void write(QName __element,
         XmlOutputStream __out,
         TypeMapper __typeMapper)
           throws IOException

Specified by:: write in interface XMLizable
Overrides:: write in class Metadata
Throws:: IOException

writeFields

protected void writeFields(XmlOutputStream __out,
               TypeMapper __typeMapper)
                    throws IOException

Overrides:: writeFields in class Metadata
Throws:: IOException

load

public void load(XmlInputStream __in,
        TypeMapper __typeMapper)
          throws IOException,
                 ConnectionException

Specified by:: load in interface XMLizable
Overrides:: load in class Metadata
Throws:: IOException; ConnectionException

loadFields

protected void loadFields(XmlInputStream __in,
              TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Overrides:: loadFields in class Metadata
Throws:: IOException; ConnectionException

toString
```
public String toString()
```
Overrides:

toString in class Metadata

Class CustomField

Constructor Summary

Method Summary

Methods inherited from class com.sforce.soap.metadata.Metadata

Methods inherited from class java.lang.Object

Constructor Detail

CustomField

Method Detail

getCaseSensitive

isCaseSensitive

setCaseSensitive

getCustomDataType

setCustomDataType

getDefaultValue

setDefaultValue

getDeleteConstraint

setDeleteConstraint

getDeprecated

isDeprecated

setDeprecated

getDescription

setDescription

getDisplayFormat

setDisplayFormat

getEncrypted

isEncrypted

setEncrypted

getEscapeMarkup

isEscapeMarkup

setEscapeMarkup

getExternalDeveloperName

setExternalDeveloperName

getExternalId

isExternalId

setExternalId

getFormula

setFormula

getFormulaTreatBlanksAs

setFormulaTreatBlanksAs

getInlineHelpText

setInlineHelpText

getIsFilteringDisabled

isIsFilteringDisabled

setIsFilteringDisabled

getIsNameField

isIsNameField

setIsNameField

getIsSortingDisabled

isIsSortingDisabled

setIsSortingDisabled

getLabel

setLabel

getLength

setLength

getLookupFilter

setLookupFilter

getMaskChar

setMaskChar

getMaskType

setMaskType

getPicklist

setPicklist

getPopulateExistingRows

isPopulateExistingRows

setPopulateExistingRows

getPrecision

setPrecision

getReferenceTargetField

setReferenceTargetField

getReferenceTo

setReferenceTo

getRelationshipLabel

setRelationshipLabel

getRelationshipName

setRelationshipName

getRelationshipOrder

setRelationshipOrder

getReparentableMasterDetail

isReparentableMasterDetail

setReparentableMasterDetail