CustomField (force-metadata-api 40.0.0 API)

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

All Implemented Interfaces:

XMLizable
```
public class CustomField
extends Metadata
```
This is a generated class for the SObject Enterprise API. Do not edit this file, as your changes will be lost.

Constructor Summary

Constructors
Constructor and Description

CustomField()
Constructor

Constructors
Constructor and Description
`CustomField()` Constructor

Method Summary

All Methods Instance Methods Concrete 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()`
`FieldManageability`	`getFieldManageability()`
`String`	`getFormula()`
`TreatBlanksAs`	`getFormulaTreatBlanksAs()`
`String`	`getInlineHelpText()`
`boolean`	`getIsConvertLeadDisabled()`
`boolean`	`getIsFilteringDisabled()`
`boolean`	`getIsNameField()`
`boolean`	`getIsSortingDisabled()`
`String`	`getLabel()`
`int`	`getLength()`
`LookupFilter`	`getLookupFilter()`
`EncryptedFieldMaskChar`	`getMaskChar()`
`EncryptedFieldMaskType`	`getMaskType()`
`String`	`getMetadataRelationshipControllingField()`
`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()`
`ValueSet`	`getValueSet()`
`int`	`getVisibleLines()`
`boolean`	`getWriteRequiresMasterRead()`
`boolean`	`isCaseSensitive()`
`boolean`	`isDeprecated()`
`boolean`	`isEncrypted()`
`boolean`	`isEscapeMarkup()`
`boolean`	`isExternalId()`
`boolean`	`isIsConvertLeadDisabled()`
`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)`
`protected void`	`setCaseSensitive(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setCustomDataType(String customDataType)`
`protected void`	`setCustomDataType(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDefaultValue(String defaultValue)`
`protected void`	`setDefaultValue(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDeleteConstraint(DeleteConstraint deleteConstraint)`
`protected void`	`setDeleteConstraint(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDeprecated(boolean deprecated)`
`protected void`	`setDeprecated(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDescription(String description)`
`protected void`	`setDescription(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDisplayFormat(String displayFormat)`
`protected void`	`setDisplayFormat(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setEncrypted(boolean encrypted)`
`protected void`	`setEncrypted(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setEscapeMarkup(boolean escapeMarkup)`
`protected void`	`setEscapeMarkup(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setExternalDeveloperName(String externalDeveloperName)`
`protected void`	`setExternalDeveloperName(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setExternalId(boolean externalId)`
`protected void`	`setExternalId(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFieldManageability(FieldManageability fieldManageability)`
`protected void`	`setFieldManageability(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFormula(String formula)`
`protected void`	`setFormula(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFormulaTreatBlanksAs(TreatBlanksAs formulaTreatBlanksAs)`
`protected void`	`setFormulaTreatBlanksAs(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setInlineHelpText(String inlineHelpText)`
`protected void`	`setInlineHelpText(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setIsConvertLeadDisabled(boolean isConvertLeadDisabled)`
`protected void`	`setIsConvertLeadDisabled(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setIsFilteringDisabled(boolean isFilteringDisabled)`
`protected void`	`setIsFilteringDisabled(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setIsNameField(boolean isNameField)`
`protected void`	`setIsNameField(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setIsSortingDisabled(boolean isSortingDisabled)`
`protected void`	`setIsSortingDisabled(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLabel(String label)`
`protected void`	`setLabel(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLength(int length)`
`protected void`	`setLength(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setLookupFilter(LookupFilter lookupFilter)`
`protected void`	`setLookupFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setMaskChar(EncryptedFieldMaskChar maskChar)`
`protected void`	`setMaskChar(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setMaskType(EncryptedFieldMaskType maskType)`
`protected void`	`setMaskType(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setMetadataRelationshipControllingField(String metadataRelationshipControllingField)`
`protected void`	`setMetadataRelationshipControllingField(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setPopulateExistingRows(boolean populateExistingRows)`
`protected void`	`setPopulateExistingRows(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setPrecision(int precision)`
`protected void`	`setPrecision(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setReferenceTargetField(String referenceTargetField)`
`protected void`	`setReferenceTargetField(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setReferenceTo(String referenceTo)`
`protected void`	`setReferenceTo(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRelationshipLabel(String relationshipLabel)`
`protected void`	`setRelationshipLabel(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRelationshipName(String relationshipName)`
`protected void`	`setRelationshipName(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRelationshipOrder(int relationshipOrder)`
`protected void`	`setRelationshipOrder(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setReparentableMasterDetail(boolean reparentableMasterDetail)`
`protected void`	`setReparentableMasterDetail(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRequired(boolean required)`
`protected void`	`setRequired(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRestrictedAdminField(boolean restrictedAdminField)`
`protected void`	`setRestrictedAdminField(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setScale(int scale)`
`protected void`	`setScale(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setStartingNumber(int startingNumber)`
`protected void`	`setStartingNumber(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setStripMarkup(boolean stripMarkup)`
`protected void`	`setStripMarkup(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSummarizedField(String summarizedField)`
`protected void`	`setSummarizedField(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSummaryFilterItems(FilterItem[] summaryFilterItems)`
`protected void`	`setSummaryFilterItems(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSummaryForeignKey(String summaryForeignKey)`
`protected void`	`setSummaryForeignKey(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSummaryOperation(SummaryOperations summaryOperation)`
`protected void`	`setSummaryOperation(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setTrackFeedHistory(boolean trackFeedHistory)`
`protected void`	`setTrackFeedHistory(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setTrackHistory(boolean trackHistory)`
`protected void`	`setTrackHistory(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setTrackTrending(boolean trackTrending)`
`protected void`	`setTrackTrending(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setType(FieldType type)`
`protected void`	`setType(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setUnique(boolean unique)`
`protected void`	`setUnique(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setValueSet(ValueSet valueSet)`
`protected void`	`setValueSet(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setVisibleLines(int visibleLines)`
`protected void`	`setVisibleLines(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setWriteRequiresMasterRead(boolean writeRequiresMasterRead)`
`protected void`	`setWriteRequiresMasterRead(XmlInputStream __in, TypeMapper __typeMapper)`
`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, 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)

setCaseSensitive

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

Throws:: IOException; ConnectionException

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

setCustomDataType

public void setCustomDataType(String customDataType)

setCustomDataType

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

Throws:: IOException; ConnectionException

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

setDefaultValue

public void setDefaultValue(String defaultValue)

setDefaultValue

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

Throws:: IOException; ConnectionException

getDeleteConstraint

public DeleteConstraint getDeleteConstraint()

setDeleteConstraint

public void setDeleteConstraint(DeleteConstraint deleteConstraint)

setDeleteConstraint

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

Throws:: IOException; ConnectionException

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

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

setDeprecated

public void setDeprecated(boolean deprecated)

setDeprecated

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

Throws:: IOException; ConnectionException

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

setDescription

public void setDescription(String description)

setDescription

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

Throws:: IOException; ConnectionException

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

setDisplayFormat

public void setDisplayFormat(String displayFormat)

setDisplayFormat

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

Throws:: IOException; ConnectionException

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

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

setEncrypted

public void setEncrypted(boolean encrypted)

setEncrypted

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

Throws:: IOException; ConnectionException

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

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

setEscapeMarkup

public void setEscapeMarkup(boolean escapeMarkup)

setEscapeMarkup

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

Throws:: IOException; ConnectionException

getExternalDeveloperName

public String getExternalDeveloperName()

setExternalDeveloperName

public void setExternalDeveloperName(String externalDeveloperName)

setExternalDeveloperName

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

Throws:: IOException; ConnectionException

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

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

setExternalId

public void setExternalId(boolean externalId)

setExternalId

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

Throws:: IOException; ConnectionException

getFieldManageability

public FieldManageability getFieldManageability()

setFieldManageability

public void setFieldManageability(FieldManageability fieldManageability)

setFieldManageability

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

Throws:: IOException; ConnectionException

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

setFormula

public void setFormula(String formula)

setFormula

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

Throws:: IOException; ConnectionException

getFormulaTreatBlanksAs

public TreatBlanksAs getFormulaTreatBlanksAs()

setFormulaTreatBlanksAs

public void setFormulaTreatBlanksAs(TreatBlanksAs formulaTreatBlanksAs)

setFormulaTreatBlanksAs

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

Throws:: IOException; ConnectionException

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

setInlineHelpText

public void setInlineHelpText(String inlineHelpText)

setInlineHelpText

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

Throws:: IOException; ConnectionException

getIsConvertLeadDisabled

public boolean getIsConvertLeadDisabled()

isIsConvertLeadDisabled

public boolean isIsConvertLeadDisabled()

setIsConvertLeadDisabled

public void setIsConvertLeadDisabled(boolean isConvertLeadDisabled)

setIsConvertLeadDisabled

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

Throws:: IOException; ConnectionException

getIsFilteringDisabled

public boolean getIsFilteringDisabled()

isIsFilteringDisabled

public boolean isIsFilteringDisabled()

setIsFilteringDisabled

public void setIsFilteringDisabled(boolean isFilteringDisabled)

setIsFilteringDisabled

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

Throws:: IOException; ConnectionException

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

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

setIsNameField

public void setIsNameField(boolean isNameField)

setIsNameField

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

Throws:: IOException; ConnectionException

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

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

setIsSortingDisabled

public void setIsSortingDisabled(boolean isSortingDisabled)

setIsSortingDisabled

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

Throws:: IOException; ConnectionException

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

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

setLabel

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

Throws:: IOException; ConnectionException

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

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

setLength

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

Throws:: IOException; ConnectionException

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

setLookupFilter

public void setLookupFilter(LookupFilter lookupFilter)

setLookupFilter

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

Throws:: IOException; ConnectionException

getMaskChar

public EncryptedFieldMaskChar getMaskChar()

setMaskChar

public void setMaskChar(EncryptedFieldMaskChar maskChar)

setMaskChar

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

Throws:: IOException; ConnectionException

getMaskType

public EncryptedFieldMaskType getMaskType()

setMaskType

public void setMaskType(EncryptedFieldMaskType maskType)

setMaskType

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

Throws:: IOException; ConnectionException

getMetadataRelationshipControllingField

public String getMetadataRelationshipControllingField()

setMetadataRelationshipControllingField

public void setMetadataRelationshipControllingField(String metadataRelationshipControllingField)

setMetadataRelationshipControllingField

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

Throws:: IOException; ConnectionException

getPopulateExistingRows

public boolean getPopulateExistingRows()

isPopulateExistingRows

public boolean isPopulateExistingRows()

setPopulateExistingRows

public void setPopulateExistingRows(boolean populateExistingRows)

setPopulateExistingRows

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

Throws:: IOException; ConnectionException

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

setPrecision

public void setPrecision(int precision)

setPrecision

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

Throws:: IOException; ConnectionException

getReferenceTargetField

public String getReferenceTargetField()

setReferenceTargetField

public void setReferenceTargetField(String referenceTargetField)

setReferenceTargetField

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

Throws:: IOException; ConnectionException

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

setReferenceTo

public void setReferenceTo(String referenceTo)

setReferenceTo

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

Throws:: IOException; ConnectionException

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

setRelationshipLabel

public void setRelationshipLabel(String relationshipLabel)

setRelationshipLabel

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

Throws:: IOException; ConnectionException

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

setRelationshipName

public void setRelationshipName(String relationshipName)

setRelationshipName

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

Throws:: IOException; ConnectionException

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

setRelationshipOrder

public void setRelationshipOrder(int relationshipOrder)

setRelationshipOrder

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

Throws:: IOException; ConnectionException

getReparentableMasterDetail

public boolean getReparentableMasterDetail()

isReparentableMasterDetail

public boolean isReparentableMasterDetail()

setReparentableMasterDetail

public void setReparentableMasterDetail(boolean reparentableMasterDetail)

setReparentableMasterDetail

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

Throws:: IOException; ConnectionException

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

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

setRequired

public void setRequired(boolean required)

setRequired

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

Throws:: IOException; ConnectionException

getRestrictedAdminField

public boolean getRestrictedAdminField()

isRestrictedAdminField

public boolean isRestrictedAdminField()

setRestrictedAdminField

public void setRestrictedAdminField(boolean restrictedAdminField)

setRestrictedAdminField

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

Throws:: IOException; ConnectionException

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

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

setScale

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

Throws:: IOException; ConnectionException

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

setStartingNumber

public void setStartingNumber(int startingNumber)

setStartingNumber

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

Throws:: IOException; ConnectionException

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

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

setStripMarkup

public void setStripMarkup(boolean stripMarkup)

setStripMarkup

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

Throws:: IOException; ConnectionException

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

setSummarizedField

public void setSummarizedField(String summarizedField)

setSummarizedField

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

Throws:: IOException; ConnectionException

getSummaryFilterItems

public FilterItem[] getSummaryFilterItems()

setSummaryFilterItems

public void setSummaryFilterItems(FilterItem[] summaryFilterItems)

setSummaryFilterItems

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

Throws:: IOException; ConnectionException

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

setSummaryForeignKey

public void setSummaryForeignKey(String summaryForeignKey)

setSummaryForeignKey

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

Throws:: IOException; ConnectionException

getSummaryOperation

public SummaryOperations getSummaryOperation()

setSummaryOperation

public void setSummaryOperation(SummaryOperations summaryOperation)

setSummaryOperation

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

Throws:: IOException; ConnectionException

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

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

setTrackFeedHistory

public void setTrackFeedHistory(boolean trackFeedHistory)

setTrackFeedHistory

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

Throws:: IOException; ConnectionException

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

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

setTrackHistory

public void setTrackHistory(boolean trackHistory)

setTrackHistory

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

Throws:: IOException; ConnectionException

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

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

setTrackTrending

public void setTrackTrending(boolean trackTrending)

setTrackTrending

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

Throws:: IOException; ConnectionException

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

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

setType

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

Throws:: IOException; ConnectionException

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

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

setUnique

public void setUnique(boolean unique)

setUnique

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

Throws:: IOException; ConnectionException

getValueSet
```
public ValueSet getValueSet()
```

setValueSet

public void setValueSet(ValueSet valueSet)

setValueSet

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

Throws:: IOException; ConnectionException

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

setVisibleLines

public void setVisibleLines(int visibleLines)

setVisibleLines

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

Throws:: IOException; ConnectionException

getWriteRequiresMasterRead

public boolean getWriteRequiresMasterRead()

isWriteRequiresMasterRead

public boolean isWriteRequiresMasterRead()

setWriteRequiresMasterRead

public void setWriteRequiresMasterRead(boolean writeRequiresMasterRead)

setWriteRequiresMasterRead

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

Throws:: IOException; ConnectionException

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

setCaseSensitive

getCustomDataType

setCustomDataType

setCustomDataType

getDefaultValue

setDefaultValue

setDefaultValue

getDeleteConstraint

setDeleteConstraint

setDeleteConstraint

getDeprecated

isDeprecated

setDeprecated

setDeprecated

getDescription

setDescription

setDescription

getDisplayFormat

setDisplayFormat

setDisplayFormat

getEncrypted

isEncrypted

setEncrypted

setEncrypted

getEscapeMarkup

isEscapeMarkup

setEscapeMarkup

setEscapeMarkup

getExternalDeveloperName

setExternalDeveloperName

setExternalDeveloperName

getExternalId

isExternalId

setExternalId

setExternalId

getFieldManageability

setFieldManageability

setFieldManageability

getFormula

setFormula

setFormula

getFormulaTreatBlanksAs

setFormulaTreatBlanksAs

setFormulaTreatBlanksAs

getInlineHelpText

setInlineHelpText

setInlineHelpText

getIsConvertLeadDisabled

isIsConvertLeadDisabled

setIsConvertLeadDisabled

setIsConvertLeadDisabled

getIsFilteringDisabled

isIsFilteringDisabled

setIsFilteringDisabled

setIsFilteringDisabled

getIsNameField

isIsNameField

setIsNameField

setIsNameField

getIsSortingDisabled

isIsSortingDisabled

setIsSortingDisabled

setIsSortingDisabled

getLabel

setLabel

setLabel

getLength

setLength

setLength