DescribeSObject.Field (force-rest-api 0.0.30 API)

java.lang.Object
- com.force.api.DescribeSObject.Field

Enclosing class:

DescribeSObject
```
public static class DescribeSObject.Field
extends Object
```
This class represents part of a JSON response from /services/data/v{version}/sobjects/{sobjectName}/describe

Since:

170

Author:

gwester

Constructor Summary

Constructors
Constructor and Description

Field()

Constructors
Constructor and Description
`Field()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDefaultValue()`
`String`	`getInlineHelpText()`
`String`	`getLabel()`
`Integer`	`getLength()`
`String`	`getName()`
`List<DescribeSObject.PicklistEntry>`	`getPicklistValues()`
`List<String>`	`getReferenceTo()`
`List<String>`	`getReferenceToEntity()`
`String`	`getRelationshipName()`
`String`	`getSoapType()`
`String`	`getType()`
`Boolean`	`isAutoNumber()`
`Boolean`	`isCalculated()`
`Boolean`	`isCaseSensitive()`
`Boolean`	`isCreateable()`
`Boolean`	`isCustom()`
`Boolean`	`isDefaultedOnCreate()`
`Boolean`	`isDependentPicklist()`
`Boolean`	`isDeprecatedAndHidden()`
`Boolean`	`isExternalId()`
`Boolean`	`isFilterable()`
`Boolean`	`isGroupable()`
`Boolean`	`isHtmlFormatted()`
`Boolean`	`isIdLookup()`
`Boolean`	`isNameField()`
`Boolean`	`isNamePointing()`
`Boolean`	`isNillable()`
`Boolean`	`isRestrictedPicklist()`
`Boolean`	`isSortable()`
`Boolean`	`isUnique()`
`Boolean`	`isUpdateable()`
`Boolean`	`isWriteRequiresMasterRead()`

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

Constructor Detail
- Field
```
public Field()
```

Method Detail

getLength
```
public Integer getLength()
```

getName
```
public String getName()
```

getType
```
public String getType()
```

getSoapType
```
public String getSoapType()
```

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

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

isUpdateable
```
public Boolean isUpdateable()
```

isCalculated
```
public Boolean isCalculated()
```

isUnique
```
public Boolean isUnique()
```

isNillable
```
public Boolean isNillable()
```

isCaseSensitive
```
public Boolean isCaseSensitive()
```

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

isNameField
```
public Boolean isNameField()
```

isExternalId
```
public Boolean isExternalId()
```

isIdLookup
```
public Boolean isIdLookup()
```

isFilterable
```
public Boolean isFilterable()
```

isCreateable
```
public Boolean isCreateable()
```

isDeprecatedAndHidden

public Boolean isDeprecatedAndHidden()

getPicklistValues

public List<DescribeSObject.PicklistEntry> getPicklistValues()

isAutoNumber
```
public Boolean isAutoNumber()
```

isDefaultedOnCreate
```
public Boolean isDefaultedOnCreate()
```

isGroupable
```
public Boolean isGroupable()
```

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

getReferenceTo
```
public List<String> getReferenceTo()
```

getReferenceToEntity

public List<String> getReferenceToEntity()

isRestrictedPicklist
```
public Boolean isRestrictedPicklist()
```

isNamePointing
```
public Boolean isNamePointing()
```

isCustom
```
public Boolean isCustom()
```

isHtmlFormatted
```
public Boolean isHtmlFormatted()
```

isDependentPicklist
```
public Boolean isDependentPicklist()
```

isWriteRequiresMasterRead

public Boolean isWriteRequiresMasterRead()

isSortable
```
public Boolean isSortable()
```

Class DescribeSObject.Field

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Field

Method Detail

getLength

getName

getType

getSoapType

getDefaultValue

getLabel

isUpdateable

isCalculated

isUnique

isNillable

isCaseSensitive

getInlineHelpText

isNameField

isExternalId

isIdLookup

isFilterable

isCreateable

isDeprecatedAndHidden

getPicklistValues

isAutoNumber

isDefaultedOnCreate

isGroupable

getRelationshipName

getReferenceTo

getReferenceToEntity

isRestrictedPicklist

isNamePointing

isCustom

isHtmlFormatted

isDependentPicklist

isWriteRequiresMasterRead

isSortable