com.sforce.soap.partner
Class Field

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

All Implemented Interfaces:

java.io.Serializable

public class Field
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Field()

Field(boolean autoNumber, int byteLength, boolean calculated, java.lang.String calculatedFormula, boolean caseSensitive, java.lang.String controllerName, boolean createable, boolean custom, java.lang.String defaultValueFormula, boolean defaultedOnCreate, java.lang.Boolean dependentPicklist, int digits, java.lang.Boolean externalId, boolean filterable, java.lang.Boolean htmlFormatted, boolean idLookup, java.lang.String inlineHelpText, java.lang.String label, int length, java.lang.String name, boolean nameField, java.lang.Boolean namePointing, boolean nillable, PicklistEntry[] picklistValues, int precision, java.lang.String[] referenceTo, java.lang.String relationshipName, java.lang.Integer relationshipOrder, boolean restrictedPicklist, int scale, SoapType soapType, java.lang.Boolean sortable, FieldType type, boolean unique, boolean updateable, java.lang.Boolean writeRequiresMasterRead)

Method Summary

boolean	equals(java.lang.Object obj)
int	getByteLength() Gets the byteLength value for this Field.
java.lang.String	getCalculatedFormula() Gets the calculatedFormula value for this Field.
java.lang.String	getControllerName() Gets the controllerName value for this Field.
java.lang.String	getDefaultValueFormula() Gets the defaultValueFormula value for this Field.
java.lang.Boolean	getDependentPicklist() Gets the dependentPicklist value for this Field.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Deserializer
int	getDigits() Gets the digits value for this Field.
java.lang.Boolean	getExternalId() Gets the externalId value for this Field.
java.lang.Boolean	getHtmlFormatted() Gets the htmlFormatted value for this Field.
java.lang.String	getInlineHelpText() Gets the inlineHelpText value for this Field.
java.lang.String	getLabel() Gets the label value for this Field.
int	getLength() Gets the length value for this Field.
java.lang.String	getName() Gets the name value for this Field.
java.lang.Boolean	getNamePointing() Gets the namePointing value for this Field.
PicklistEntry[]	getPicklistValues() Gets the picklistValues value for this Field.
PicklistEntry	getPicklistValues(int i)
int	getPrecision() Gets the precision value for this Field.
java.lang.String[]	getReferenceTo() Gets the referenceTo value for this Field.
java.lang.String	getReferenceTo(int i)
java.lang.String	getRelationshipName() Gets the relationshipName value for this Field.
java.lang.Integer	getRelationshipOrder() Gets the relationshipOrder value for this Field.
int	getScale() Gets the scale value for this Field.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Serializer
SoapType	getSoapType() Gets the soapType value for this Field.
java.lang.Boolean	getSortable() Gets the sortable value for this Field.
FieldType	getType() Gets the type value for this Field.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
java.lang.Boolean	getWriteRequiresMasterRead() Gets the writeRequiresMasterRead value for this Field.
int	hashCode()
boolean	isAutoNumber() Gets the autoNumber value for this Field.
boolean	isCalculated() Gets the calculated value for this Field.
boolean	isCaseSensitive() Gets the caseSensitive value for this Field.
boolean	isCreateable() Gets the createable value for this Field.
boolean	isCustom() Gets the custom value for this Field.
boolean	isDefaultedOnCreate() Gets the defaultedOnCreate value for this Field.
boolean	isFilterable() Gets the filterable value for this Field.
boolean	isIdLookup() Gets the idLookup value for this Field.
boolean	isNameField() Gets the nameField value for this Field.
boolean	isNillable() Gets the nillable value for this Field.
boolean	isRestrictedPicklist() Gets the restrictedPicklist value for this Field.
boolean	isUnique() Gets the unique value for this Field.
boolean	isUpdateable() Gets the updateable value for this Field.
void	setAutoNumber(boolean autoNumber) Sets the autoNumber value for this Field.
void	setByteLength(int byteLength) Sets the byteLength value for this Field.
void	setCalculated(boolean calculated) Sets the calculated value for this Field.
void	setCalculatedFormula(java.lang.String calculatedFormula) Sets the calculatedFormula value for this Field.
void	setCaseSensitive(boolean caseSensitive) Sets the caseSensitive value for this Field.
void	setControllerName(java.lang.String controllerName) Sets the controllerName value for this Field.
void	setCreateable(boolean createable) Sets the createable value for this Field.
void	setCustom(boolean custom) Sets the custom value for this Field.
void	setDefaultedOnCreate(boolean defaultedOnCreate) Sets the defaultedOnCreate value for this Field.
void	setDefaultValueFormula(java.lang.String defaultValueFormula) Sets the defaultValueFormula value for this Field.
void	setDependentPicklist(java.lang.Boolean dependentPicklist) Sets the dependentPicklist value for this Field.
void	setDigits(int digits) Sets the digits value for this Field.
void	setExternalId(java.lang.Boolean externalId) Sets the externalId value for this Field.
void	setFilterable(boolean filterable) Sets the filterable value for this Field.
void	setHtmlFormatted(java.lang.Boolean htmlFormatted) Sets the htmlFormatted value for this Field.
void	setIdLookup(boolean idLookup) Sets the idLookup value for this Field.
void	setInlineHelpText(java.lang.String inlineHelpText) Sets the inlineHelpText value for this Field.
void	setLabel(java.lang.String label) Sets the label value for this Field.
void	setLength(int length) Sets the length value for this Field.
void	setName(java.lang.String name) Sets the name value for this Field.
void	setNameField(boolean nameField) Sets the nameField value for this Field.
void	setNamePointing(java.lang.Boolean namePointing) Sets the namePointing value for this Field.
void	setNillable(boolean nillable) Sets the nillable value for this Field.
void	setPicklistValues(int i, PicklistEntry _value)
void	setPicklistValues(PicklistEntry[] picklistValues) Sets the picklistValues value for this Field.
void	setPrecision(int precision) Sets the precision value for this Field.
void	setReferenceTo(int i, java.lang.String _value)
void	setReferenceTo(java.lang.String[] referenceTo) Sets the referenceTo value for this Field.
void	setRelationshipName(java.lang.String relationshipName) Sets the relationshipName value for this Field.
void	setRelationshipOrder(java.lang.Integer relationshipOrder) Sets the relationshipOrder value for this Field.
void	setRestrictedPicklist(boolean restrictedPicklist) Sets the restrictedPicklist value for this Field.
void	setScale(int scale) Sets the scale value for this Field.
void	setSoapType(SoapType soapType) Sets the soapType value for this Field.
void	setSortable(java.lang.Boolean sortable) Sets the sortable value for this Field.
void	setType(FieldType type) Sets the type value for this Field.
void	setUnique(boolean unique) Sets the unique value for this Field.
void	setUpdateable(boolean updateable) Sets the updateable value for this Field.
void	setWriteRequiresMasterRead(java.lang.Boolean writeRequiresMasterRead) Sets the writeRequiresMasterRead value for this Field.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field()

Field

public Field(boolean autoNumber,
             int byteLength,
             boolean calculated,
             java.lang.String calculatedFormula,
             boolean caseSensitive,
             java.lang.String controllerName,
             boolean createable,
             boolean custom,
             java.lang.String defaultValueFormula,
             boolean defaultedOnCreate,
             java.lang.Boolean dependentPicklist,
             int digits,
             java.lang.Boolean externalId,
             boolean filterable,
             java.lang.Boolean htmlFormatted,
             boolean idLookup,
             java.lang.String inlineHelpText,
             java.lang.String label,
             int length,
             java.lang.String name,
             boolean nameField,
             java.lang.Boolean namePointing,
             boolean nillable,
             PicklistEntry[] picklistValues,
             int precision,
             java.lang.String[] referenceTo,
             java.lang.String relationshipName,
             java.lang.Integer relationshipOrder,
             boolean restrictedPicklist,
             int scale,
             SoapType soapType,
             java.lang.Boolean sortable,
             FieldType type,
             boolean unique,
             boolean updateable,
             java.lang.Boolean writeRequiresMasterRead)

Method Detail

isAutoNumber

public boolean isAutoNumber()

Gets the autoNumber value for this Field.

Returns:

autoNumber

setAutoNumber

public void setAutoNumber(boolean autoNumber)

Sets the autoNumber value for this Field.

Parameters:

autoNumber -

getByteLength

public int getByteLength()

Gets the byteLength value for this Field.

Returns:

byteLength

setByteLength

public void setByteLength(int byteLength)

Sets the byteLength value for this Field.

Parameters:

byteLength -

isCalculated

public boolean isCalculated()

Gets the calculated value for this Field.

Returns:

calculated

setCalculated

public void setCalculated(boolean calculated)

Sets the calculated value for this Field.

Parameters:

calculated -

getCalculatedFormula

public java.lang.String getCalculatedFormula()

Gets the calculatedFormula value for this Field.

Returns:

calculatedFormula

setCalculatedFormula

public void setCalculatedFormula(java.lang.String calculatedFormula)

Sets the calculatedFormula value for this Field.

Parameters:

calculatedFormula -

isCaseSensitive

public boolean isCaseSensitive()

Gets the caseSensitive value for this Field.

Returns:

caseSensitive

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets the caseSensitive value for this Field.

Parameters:

caseSensitive -

getControllerName

public java.lang.String getControllerName()

Gets the controllerName value for this Field.

Returns:

controllerName

setControllerName

public void setControllerName(java.lang.String controllerName)

Sets the controllerName value for this Field.

Parameters:

controllerName -

isCreateable

public boolean isCreateable()

Gets the createable value for this Field.

Returns:

createable

setCreateable

public void setCreateable(boolean createable)

Sets the createable value for this Field.

Parameters:

createable -

isCustom

public boolean isCustom()

Gets the custom value for this Field.

Returns:

custom

setCustom

public void setCustom(boolean custom)

Sets the custom value for this Field.

Parameters:

custom -

getDefaultValueFormula

public java.lang.String getDefaultValueFormula()

Gets the defaultValueFormula value for this Field.

Returns:

defaultValueFormula

setDefaultValueFormula

public void setDefaultValueFormula(java.lang.String defaultValueFormula)

Sets the defaultValueFormula value for this Field.

Parameters:

defaultValueFormula -

isDefaultedOnCreate

public boolean isDefaultedOnCreate()

Gets the defaultedOnCreate value for this Field.

Returns:

defaultedOnCreate

setDefaultedOnCreate

public void setDefaultedOnCreate(boolean defaultedOnCreate)

Sets the defaultedOnCreate value for this Field.

Parameters:

defaultedOnCreate -

getDependentPicklist

public java.lang.Boolean getDependentPicklist()

Gets the dependentPicklist value for this Field.

Returns:

dependentPicklist

setDependentPicklist

public void setDependentPicklist(java.lang.Boolean dependentPicklist)

Sets the dependentPicklist value for this Field.

Parameters:

dependentPicklist -

getDigits

public int getDigits()

Gets the digits value for this Field.

Returns:

digits

setDigits

public void setDigits(int digits)

Sets the digits value for this Field.

Parameters:

digits -

getExternalId

public java.lang.Boolean getExternalId()

Gets the externalId value for this Field.

Returns:

externalId

setExternalId

public void setExternalId(java.lang.Boolean externalId)

Sets the externalId value for this Field.

Parameters:

externalId -

isFilterable

public boolean isFilterable()

Gets the filterable value for this Field.

Returns:

filterable

setFilterable

public void setFilterable(boolean filterable)

Sets the filterable value for this Field.

Parameters:

filterable -

getHtmlFormatted

public java.lang.Boolean getHtmlFormatted()

Gets the htmlFormatted value for this Field.

Returns:

htmlFormatted

setHtmlFormatted

public void setHtmlFormatted(java.lang.Boolean htmlFormatted)

Sets the htmlFormatted value for this Field.

Parameters:

htmlFormatted -

isIdLookup

public boolean isIdLookup()

Gets the idLookup value for this Field.

Returns:

idLookup

setIdLookup

public void setIdLookup(boolean idLookup)

Sets the idLookup value for this Field.

Parameters:

idLookup -

getInlineHelpText

public java.lang.String getInlineHelpText()

Gets the inlineHelpText value for this Field.

Returns:

inlineHelpText

setInlineHelpText

public void setInlineHelpText(java.lang.String inlineHelpText)

Sets the inlineHelpText value for this Field.

Parameters:

inlineHelpText -

getLabel

public java.lang.String getLabel()

Gets the label value for this Field.

Returns:

label

setLabel

public void setLabel(java.lang.String label)

Sets the label value for this Field.

Parameters:

label -

getLength

public int getLength()

Gets the length value for this Field.

Returns:

length

setLength

public void setLength(int length)

Sets the length value for this Field.

Parameters:

length -

getName

public java.lang.String getName()

Gets the name value for this Field.

Returns:

name

setName

public void setName(java.lang.String name)

Sets the name value for this Field.

Parameters:

name -

isNameField

public boolean isNameField()

Gets the nameField value for this Field.

Returns:

nameField

setNameField

public void setNameField(boolean nameField)

Sets the nameField value for this Field.

Parameters:

nameField -

getNamePointing

public java.lang.Boolean getNamePointing()

Gets the namePointing value for this Field.

Returns:

namePointing

setNamePointing

public void setNamePointing(java.lang.Boolean namePointing)

Sets the namePointing value for this Field.

Parameters:

namePointing -

isNillable

public boolean isNillable()

Gets the nillable value for this Field.

Returns:

nillable

setNillable

public void setNillable(boolean nillable)

Sets the nillable value for this Field.

Parameters:

nillable -

getPicklistValues

public PicklistEntry[] getPicklistValues()

Gets the picklistValues value for this Field.

Returns:

picklistValues

setPicklistValues

public void setPicklistValues(PicklistEntry[] picklistValues)

Sets the picklistValues value for this Field.

Parameters:

picklistValues -

getPicklistValues

public PicklistEntry getPicklistValues(int i)

setPicklistValues

public void setPicklistValues(int i,
                              PicklistEntry _value)

getPrecision

public int getPrecision()

Gets the precision value for this Field.

Returns:

precision

setPrecision

public void setPrecision(int precision)

Sets the precision value for this Field.

Parameters:

precision -

getReferenceTo

public java.lang.String[] getReferenceTo()

Gets the referenceTo value for this Field.

Returns:

referenceTo

setReferenceTo

public void setReferenceTo(java.lang.String[] referenceTo)

Sets the referenceTo value for this Field.

Parameters:

referenceTo -

getReferenceTo

public java.lang.String getReferenceTo(int i)

setReferenceTo

public void setReferenceTo(int i,
                           java.lang.String _value)

getRelationshipName

public java.lang.String getRelationshipName()

Gets the relationshipName value for this Field.

Returns:

relationshipName

setRelationshipName

public void setRelationshipName(java.lang.String relationshipName)

Sets the relationshipName value for this Field.

Parameters:

relationshipName -

getRelationshipOrder

public java.lang.Integer getRelationshipOrder()

Gets the relationshipOrder value for this Field.

Returns:

relationshipOrder

setRelationshipOrder

public void setRelationshipOrder(java.lang.Integer relationshipOrder)

Sets the relationshipOrder value for this Field.

Parameters:

relationshipOrder -

isRestrictedPicklist

public boolean isRestrictedPicklist()

Gets the restrictedPicklist value for this Field.

Returns:

restrictedPicklist

setRestrictedPicklist

public void setRestrictedPicklist(boolean restrictedPicklist)

Sets the restrictedPicklist value for this Field.

Parameters:

restrictedPicklist -

getScale

public int getScale()

Gets the scale value for this Field.

Returns:

scale

setScale

public void setScale(int scale)

Sets the scale value for this Field.

Parameters:

scale -

getSoapType

public SoapType getSoapType()

Gets the soapType value for this Field.

Returns:

soapType

setSoapType

public void setSoapType(SoapType soapType)

Sets the soapType value for this Field.

Parameters:

soapType -

getSortable

public java.lang.Boolean getSortable()

Gets the sortable value for this Field.

Returns:

sortable

setSortable

public void setSortable(java.lang.Boolean sortable)

Sets the sortable value for this Field.

Parameters:

sortable -

getType

public FieldType getType()

Gets the type value for this Field.

Returns:

type

setType

public void setType(FieldType type)

Sets the type value for this Field.

Parameters:

type -

isUnique

public boolean isUnique()

Gets the unique value for this Field.

Returns:

unique

setUnique

public void setUnique(boolean unique)

Sets the unique value for this Field.

Parameters:

unique -

isUpdateable

public boolean isUpdateable()

Gets the updateable value for this Field.

Returns:

updateable

setUpdateable

public void setUpdateable(boolean updateable)

Sets the updateable value for this Field.

Parameters:

updateable -

getWriteRequiresMasterRead

public java.lang.Boolean getWriteRequiresMasterRead()

Gets the writeRequiresMasterRead value for this Field.

Returns:

writeRequiresMasterRead

setWriteRequiresMasterRead

public void setWriteRequiresMasterRead(java.lang.Boolean writeRequiresMasterRead)

Sets the writeRequiresMasterRead value for this Field.

Parameters:

writeRequiresMasterRead -

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Get Custom Deserializer