com.sforce.soap.partner
Class Field

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

All Implemented Interfaces:

XMLizable

public class Field
extends Object
implements XMLizable

Generated class, please do not edit.

Constructor Summary

Field()
Constructor

Method Summary

boolean	getAutoNumber()
int	getByteLength()
boolean	getCalculated()
String	getCalculatedFormula()
boolean	getCaseSensitive()
String	getControllerName()
boolean	getCreateable()
boolean	getCustom()
boolean	getDefaultedOnCreate()
String	getDefaultValueFormula()
boolean	getDependentPicklist()
boolean	getDeprecatedAndHidden()
int	getDigits()
boolean	getExternalId()
boolean	getFilterable()
boolean	getGroupable()
boolean	getHtmlFormatted()
boolean	getIdLookup()
String	getInlineHelpText()
String	getLabel()
int	getLength()
String	getName()
boolean	getNameField()
boolean	getNamePointing()
boolean	getNillable()
PicklistEntry[]	getPicklistValues()
int	getPrecision()
String[]	getReferenceTo()
String	getRelationshipName()
int	getRelationshipOrder()
boolean	getRestrictedPicklist()
int	getScale()
SoapType	getSoapType()
boolean	getSortable()
FieldType	getType()
boolean	getUnique()
boolean	getUpdateable()
boolean	getWriteRequiresMasterRead()
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()
void	load(XmlInputStream __in, TypeMapper __typeMapper) load the fileds/children from the specified xml stream
protected void	loadFields(XmlInputStream __in, TypeMapper __typeMapper)
void	setAutoNumber(boolean autoNumber)
void	setByteLength(int byteLength)
void	setCalculated(boolean calculated)
void	setCalculatedFormula(String calculatedFormula)
void	setCaseSensitive(boolean caseSensitive)
void	setControllerName(String controllerName)
void	setCreateable(boolean createable)
void	setCustom(boolean custom)
void	setDefaultedOnCreate(boolean defaultedOnCreate)
void	setDefaultValueFormula(String defaultValueFormula)
void	setDependentPicklist(boolean dependentPicklist)
void	setDeprecatedAndHidden(boolean deprecatedAndHidden)
void	setDigits(int digits)
void	setExternalId(boolean externalId)
void	setFilterable(boolean filterable)
void	setGroupable(boolean groupable)
void	setHtmlFormatted(boolean htmlFormatted)
void	setIdLookup(boolean idLookup)
void	setInlineHelpText(String inlineHelpText)
void	setLabel(String label)
void	setLength(int length)
void	setName(String name)
void	setNameField(boolean nameField)
void	setNamePointing(boolean namePointing)
void	setNillable(boolean nillable)
void	setPicklistValues(PicklistEntry[] picklistValues)
void	setPrecision(int precision)
void	setReferenceTo(String[] referenceTo)
void	setRelationshipName(String relationshipName)
void	setRelationshipOrder(int relationshipOrder)
void	setRestrictedPicklist(boolean restrictedPicklist)
void	setScale(int scale)
void	setSoapType(SoapType soapType)
void	setSortable(boolean sortable)
void	setType(FieldType type)
void	setUnique(boolean unique)
void	setUpdateable(boolean updateable)
void	setWriteRequiresMasterRead(boolean writeRequiresMasterRead)
String	toString()
void	write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper) write this instace as xml.
protected void	writeFields(XmlOutputStream __out, TypeMapper __typeMapper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Field

public Field()

Constructor

Method Detail

getAutoNumber

public boolean getAutoNumber()

isAutoNumber

public boolean isAutoNumber()

setAutoNumber

public void setAutoNumber(boolean autoNumber)

getByteLength

public int getByteLength()

setByteLength

public void setByteLength(int byteLength)

getCalculated

public boolean getCalculated()

isCalculated

public boolean isCalculated()

setCalculated

public void setCalculated(boolean calculated)

getCalculatedFormula

public String getCalculatedFormula()

setCalculatedFormula

public void setCalculatedFormula(String calculatedFormula)

getCaseSensitive

public boolean getCaseSensitive()

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getControllerName

public String getControllerName()

setControllerName

public void setControllerName(String controllerName)

getCreateable

public boolean getCreateable()

isCreateable

public boolean isCreateable()

setCreateable

public void setCreateable(boolean createable)

getCustom

public boolean getCustom()

isCustom

public boolean isCustom()

setCustom

public void setCustom(boolean custom)

getDefaultValueFormula

public String getDefaultValueFormula()

setDefaultValueFormula

public void setDefaultValueFormula(String defaultValueFormula)

getDefaultedOnCreate

public boolean getDefaultedOnCreate()

isDefaultedOnCreate

public boolean isDefaultedOnCreate()

setDefaultedOnCreate

public void setDefaultedOnCreate(boolean defaultedOnCreate)

getDependentPicklist

public boolean getDependentPicklist()

isDependentPicklist

public boolean isDependentPicklist()

setDependentPicklist

public void setDependentPicklist(boolean dependentPicklist)

getDeprecatedAndHidden

public boolean getDeprecatedAndHidden()

isDeprecatedAndHidden

public boolean isDeprecatedAndHidden()

setDeprecatedAndHidden

public void setDeprecatedAndHidden(boolean deprecatedAndHidden)

getDigits

public int getDigits()

setDigits

public void setDigits(int digits)

getExternalId

public boolean getExternalId()

isExternalId

public boolean isExternalId()

setExternalId

public void setExternalId(boolean externalId)

getFilterable

public boolean getFilterable()

isFilterable

public boolean isFilterable()

setFilterable

public void setFilterable(boolean filterable)

getGroupable

public boolean getGroupable()

isGroupable

public boolean isGroupable()

setGroupable

public void setGroupable(boolean groupable)

getHtmlFormatted

public boolean getHtmlFormatted()

isHtmlFormatted

public boolean isHtmlFormatted()

setHtmlFormatted

public void setHtmlFormatted(boolean htmlFormatted)

getIdLookup

public boolean getIdLookup()

isIdLookup

public boolean isIdLookup()

setIdLookup

public void setIdLookup(boolean idLookup)

getInlineHelpText

public String getInlineHelpText()

setInlineHelpText

public void setInlineHelpText(String inlineHelpText)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getLength

public int getLength()

setLength

public void setLength(int length)

getName

public String getName()

setName

public void setName(String name)

getNameField

public boolean getNameField()

isNameField

public boolean isNameField()

setNameField

public void setNameField(boolean nameField)

getNamePointing

public boolean getNamePointing()

isNamePointing

public boolean isNamePointing()

setNamePointing

public void setNamePointing(boolean namePointing)

getNillable

public boolean getNillable()

isNillable

public boolean isNillable()

setNillable

public void setNillable(boolean nillable)

getPicklistValues

public PicklistEntry[] getPicklistValues()

setPicklistValues

public void setPicklistValues(PicklistEntry[] picklistValues)

getPrecision

public int getPrecision()

setPrecision

public void setPrecision(int precision)

getReferenceTo

public String[] getReferenceTo()

setReferenceTo

public void setReferenceTo(String[] referenceTo)

getRelationshipName

public String getRelationshipName()

setRelationshipName

public void setRelationshipName(String relationshipName)

getRelationshipOrder

public int getRelationshipOrder()

setRelationshipOrder

public void setRelationshipOrder(int relationshipOrder)

getRestrictedPicklist

public boolean getRestrictedPicklist()

isRestrictedPicklist

public boolean isRestrictedPicklist()

setRestrictedPicklist

public void setRestrictedPicklist(boolean restrictedPicklist)

getScale

public int getScale()

setScale

public void setScale(int scale)

getSoapType

public SoapType getSoapType()

setSoapType

public void setSoapType(SoapType soapType)

getSortable

public boolean getSortable()

isSortable

public boolean isSortable()

setSortable

public void setSortable(boolean sortable)

getType

public FieldType getType()

setType

public void setType(FieldType type)

getUnique

public boolean getUnique()

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean unique)

getUpdateable

public boolean getUpdateable()

isUpdateable

public boolean isUpdateable()

setUpdateable

public void setUpdateable(boolean updateable)

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

Description copied from interface: XMLizable

write this instace as xml.

Specified by:

write in interface XMLizable

Parameters:

__element - xml element name

__out - xml output stream

__typeMapper - type mapper to be used

Throws:

IOException - failed to write xml

writeFields

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

Throws:

IOException

load

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

Description copied from interface: XMLizable

load the fileds/children from the specified xml stream

Specified by:

load in interface XMLizable

Parameters:

__in - xml input stream from which the data is read

__typeMapper - type mapper to be used

Throws:

IOException - failed to read xml

ConnectionException - failed to read/parser/bind xml

loadFields

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

Throws:

IOException

ConnectionException

toString

public String toString()

Overrides:

toString in class Object