public class Field
extends java.lang.Object
| Constructor and Description |
|---|
Field()
Instantiates a new field.
|
| Modifier and Type | Method and Description |
|---|---|
void |
allowDisplay(boolean allowDisplay)
Allow display.
|
void |
allowHyperlink(boolean allowHyperlink)
Allow hyperlink.
|
void |
allowMultipleValues(boolean allowMultipleValues)
Allow multiple values.
|
boolean |
canBeDeleted()
Can be deleted.
|
void |
enableLookup(boolean enableLookup)
Enable lookup.
|
void |
enablePresence(boolean enablePresence)
Enable presence.
|
java.util.List<java.lang.String> |
getChoices()
Gets the choices.
|
Locale |
getCurrencyLocale()
Gets the currency locale.
|
DateTimeFieldFormatType |
getDateFormat()
Gets the date format.
|
CalendarType |
getDateTimeCalendarType()
Gets the date time calendar type.
|
DateTimeFieldFormatType |
getDateTimeDisplayFormat()
Gets the date time display format.
|
DateTimeFieldFriendlyFormat |
getDateTimeFriendlyFormat()
Gets the date time friendly format.
|
java.lang.String |
getDefaultValue()
Gets the default value.
|
java.lang.String |
getDescription()
Gets the description.
|
Direction |
getDirection()
Gets the direction.
|
ChoiceFormatType |
getEditFormat()
Gets the edits the format.
|
java.lang.String |
getEntityPropertyName()
Gets the entity property name.
|
java.lang.String |
getFormula()
Gets the formula.
|
int |
getGridEndNumber()
Gets the grid end number.
|
java.lang.String |
getGridNonApplicableOptionText()
Gets the grid non applicable option text.
|
int |
getGridStartNumber()
Gets the grid start number.
|
java.lang.String |
getGridTextRangeAverage()
Gets the grid text range average.
|
java.lang.String |
getGridTextRangeHigh()
Gets the grid text range high.
|
java.lang.String |
getGridTextRangeLow()
Gets the grid text range low.
|
java.lang.String |
getGroup()
Gets the group.
|
java.lang.String |
getId()
Gets the id.
|
java.lang.String |
getInternalName()
Gets the internal name.
|
java.lang.String |
getJSLink()
Gets the JS link.
|
java.lang.String |
getLookupField()
Gets the lookup field.
|
java.lang.String |
getLookupList()
Gets the lookup list.
|
java.lang.String |
getLookupWebId()
Gets the lookup web id.
|
java.lang.String |
getMappings()
Gets the mappings.
|
int |
getMaximumLength()
Gets the maximum length.
|
double |
getMaximumValue()
Gets the maximum value.
|
double |
getMinimumValue()
Gets the minimum value.
|
int |
getNumberOfLines()
Gets the number of lines.
|
FieldType |
getOutputType()
Gets the output type.
|
java.lang.String |
getPrimaryFieldId()
Gets the primary field id.
|
int |
getRangeCount()
Gets the range count.
|
RelationshipDeleteBehaviorType |
getRelationshipDeleteBehavior()
Gets the relationship delete behavior.
|
FieldSchemaXml |
getSchemaXml()
Gets the schema xml.
|
java.lang.String |
getScope()
Gets the scope.
|
int |
getSelectionGroup()
Gets the selection group.
|
FieldUserSelectionMode |
getSelectionMode()
Gets the selection mode.
|
java.lang.String |
getStaticName()
Gets the static name.
|
java.lang.String |
getTitle()
Gets the title.
|
FieldType |
getType()
Gets the type.
|
java.lang.String |
getTypeAsString()
Gets the type as string.
|
java.lang.String |
getTypeDisplayName()
Gets the type display name.
|
java.lang.String |
getTypeShortDescription()
Gets the type short description.
|
UrlFieldDisplayFormat |
getUrlDisplayFormat()
Gets the url display format.
|
java.lang.String |
getValidationFormula()
Gets the validation formula.
|
java.lang.String |
getValidationMessage()
Gets the validation message.
|
boolean |
isAppendOnly()
Checks if is append only.
|
boolean |
isDisplayAllowed()
Checks if is display allowed.
|
boolean |
isEnforceUniqueValues()
Checks if is enforce unique values.
|
boolean |
isFillInChoice()
Checks if is fill in choice.
|
boolean |
isFilterable()
Checks if is filterable.
|
boolean |
isFromBaseType()
Checks if is from base type.
|
boolean |
isHidden()
Checks if is hidden.
|
boolean |
isHyperlinkAllowed()
Checks if is hyperlink allowed.
|
boolean |
isIndexed()
Checks if is indexed.
|
boolean |
isLookupEnabled()
Checks if is lookup enabled.
|
boolean |
isMultipleValuesAllowed()
Checks if is multiple values allowed.
|
boolean |
isPresenceEnabled()
Checks if is presence enabled.
|
boolean |
isReadOnly()
Checks if is read only.
|
boolean |
isRelationship()
Checks if is relationship.
|
boolean |
isRequired()
Checks if is required.
|
boolean |
isRestrictedMode()
Checks if is restricted mode.
|
boolean |
isRichText()
Checks if is rich text.
|
boolean |
isSealed()
Checks if is sealed.
|
boolean |
isSortable()
Checks if is sortable.
|
boolean |
isWikiLinking()
Checks if is wiki linking.
|
void |
setAppendOnly(boolean appendOnly)
Sets the append only.
|
void |
setCurrencyLocale(Locale currencyLocale)
Sets the currency locale.
|
void |
setDateFormat(DateTimeFieldFormatType dateFormat)
Sets the date format.
|
void |
setDateTimeCalendarType(CalendarType dateTimeCalendarType)
Sets the date time calendar type.
|
void |
setDateTimeDisplayFormat(DateTimeFieldFormatType dateTimeDisplayFormat)
Sets the date time display format.
|
void |
setDateTimeFriendlyFormat(DateTimeFieldFriendlyFormat dateTimeFriendlyFormat)
Sets the date time friendly format.
|
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value.
|
void |
setDescription(java.lang.String description)
Sets the description.
|
void |
setDirection(Direction direction)
Sets the direction.
|
void |
setEditFormat(ChoiceFormatType editFormat)
Sets the edits the format.
|
void |
setEnforceUniqueValues(boolean isEnforceUniqueValues)
Sets the enforce unique values.
|
void |
setFillInChoice(boolean fillInChoice)
Sets the fill in choice.
|
void |
setFormula(java.lang.String formula)
Sets the formula.
|
void |
setGridEndNumber(int gridEndNumber)
Sets the grid end number.
|
void |
setGridNonApplicableOptionText(java.lang.String gridNonApplicableOptionText)
Sets the grid non applicable option text.
|
void |
setGridStartNumber(int gridStartNumber)
Sets the grid start number.
|
void |
setGridTextRangeAverage(java.lang.String gridTextRangeAverage)
Sets the grid text range average.
|
void |
setGridTextRangeHigh(java.lang.String gridTextRangeHigh)
Sets the grid text range high.
|
void |
setGridTextRangeLow(java.lang.String gridTextRangeLow)
Sets the grid text range low.
|
void |
setGroup(java.lang.String group)
Sets the group.
|
void |
setHidden(boolean isHidden)
Sets the hidden.
|
void |
setIndexed(boolean isIndexed)
Sets the indexed.
|
void |
setJSLink(java.lang.String jsLink)
Sets the JS link.
|
void |
setLookupField(java.lang.String lookupField)
Sets the lookup field.
|
void |
setLookupList(java.lang.String lookupList)
Sets the lookup list.
|
void |
setLookupWebId(java.lang.String lookupWebId)
Sets the lookup web id.
|
void |
setMaximumLength(int maximumLength)
Sets the maximum length.
|
void |
setMaximumValue(double maximumValue)
Sets the maximum value.
|
void |
setMinimumValue(double minimumValue)
Sets the minimum value.
|
void |
setNumberOfLines(int numberOfLines)
Sets the number of lines.
|
void |
setOutputType(FieldType outputType)
Sets the output type.
|
void |
setPrimaryFieldId(java.lang.String primaryFieldId)
Sets the primary field id.
|
void |
setReadOnly(boolean isReadOnly)
Sets the read only.
|
void |
setRelationship(boolean isRelationship)
Sets the relationship.
|
void |
setRelationshipDeleteBehavior(RelationshipDeleteBehaviorType relationshipDeleteBehavior)
Sets the relationship delete behavior.
|
void |
setRequired(boolean isRequired)
Sets the required.
|
void |
setRestrictedMode(boolean isRestrictedMode)
Sets the restricted mode.
|
void |
setRichText(boolean isRichText)
Sets the rich text.
|
void |
setSchemaXml(FieldSchemaXml schemaXml)
Sets the schema xml.
|
void |
setScope(java.lang.String scope)
Sets the scope.
|
void |
setSealed(boolean isSealed)
Sets the sealed.
|
void |
setSelectionGroup(int selectionGroup)
Sets the selection group.
|
void |
setSelectionMode(FieldUserSelectionMode selectionMode)
Sets the selection mode.
|
void |
setSortable(boolean isSortable)
Sets the sortable.
|
void |
setStaticName(java.lang.String staticName)
Sets the static name.
|
void |
setTitle(java.lang.String title)
Sets the title.
|
void |
setType(FieldType type)
Sets the type.
|
void |
setTypeAsString(java.lang.String typeAsString)
Sets the type as string.
|
void |
setUrlDisplayFormat(UrlFieldDisplayFormat urlDisplayFormat)
Sets the url display format.
|
void |
setValidationFormula(java.lang.String validationFormula)
Sets the validation formula.
|
void |
setValidationMessage(java.lang.String validationMessage)
Sets the validation message.
|
public void allowDisplay(boolean allowDisplay)
allowDisplay - the allow displaypublic void allowHyperlink(boolean allowHyperlink)
allowHyperlink - the allow hyperlinkpublic void allowMultipleValues(boolean allowMultipleValues)
allowMultipleValues - the allow multiple valuespublic boolean canBeDeleted()
public void enableLookup(boolean enableLookup)
enableLookup - the enable lookuppublic void enablePresence(boolean enablePresence)
enablePresence - the enable presencepublic java.util.List<java.lang.String> getChoices()
public Locale getCurrencyLocale()
public DateTimeFieldFormatType getDateFormat()
public CalendarType getDateTimeCalendarType()
public DateTimeFieldFormatType getDateTimeDisplayFormat()
public DateTimeFieldFriendlyFormat getDateTimeFriendlyFormat()
public java.lang.String getDefaultValue()
public java.lang.String getDescription()
public Direction getDirection()
public ChoiceFormatType getEditFormat()
public java.lang.String getEntityPropertyName()
public java.lang.String getFormula()
public int getGridEndNumber()
public java.lang.String getGridNonApplicableOptionText()
public int getGridStartNumber()
public java.lang.String getGridTextRangeAverage()
public java.lang.String getGridTextRangeHigh()
public java.lang.String getGridTextRangeLow()
public java.lang.String getGroup()
public java.lang.String getId()
public java.lang.String getInternalName()
public java.lang.String getJSLink()
public java.lang.String getLookupField()
public java.lang.String getLookupList()
public java.lang.String getLookupWebId()
public java.lang.String getMappings()
public int getMaximumLength()
public double getMaximumValue()
public double getMinimumValue()
public int getNumberOfLines()
public FieldType getOutputType()
public java.lang.String getPrimaryFieldId()
public int getRangeCount()
public RelationshipDeleteBehaviorType getRelationshipDeleteBehavior()
public FieldSchemaXml getSchemaXml()
public java.lang.String getScope()
public int getSelectionGroup()
public FieldUserSelectionMode getSelectionMode()
public java.lang.String getStaticName()
public java.lang.String getTitle()
public FieldType getType()
public java.lang.String getTypeAsString()
public java.lang.String getTypeDisplayName()
public java.lang.String getTypeShortDescription()
public UrlFieldDisplayFormat getUrlDisplayFormat()
public java.lang.String getValidationFormula()
public java.lang.String getValidationMessage()
public boolean isAppendOnly()
public boolean isDisplayAllowed()
public boolean isEnforceUniqueValues()
public boolean isFillInChoice()
public boolean isFilterable()
public boolean isFromBaseType()
public boolean isHidden()
public boolean isHyperlinkAllowed()
public boolean isIndexed()
public boolean isLookupEnabled()
public boolean isMultipleValuesAllowed()
public boolean isPresenceEnabled()
public boolean isReadOnly()
public boolean isRelationship()
public boolean isRequired()
public boolean isRestrictedMode()
public boolean isRichText()
public boolean isSealed()
public boolean isSortable()
public boolean isWikiLinking()
public void setAppendOnly(boolean appendOnly)
appendOnly - the new append onlypublic void setCurrencyLocale(Locale currencyLocale)
currencyLocale - the new currency localepublic void setDateFormat(DateTimeFieldFormatType dateFormat)
dateFormat - the new date formatpublic void setDateTimeCalendarType(CalendarType dateTimeCalendarType)
dateTimeCalendarType - the new date time calendar typepublic void setDateTimeDisplayFormat(DateTimeFieldFormatType dateTimeDisplayFormat)
dateTimeDisplayFormat - the new date time display formatpublic void setDateTimeFriendlyFormat(DateTimeFieldFriendlyFormat dateTimeFriendlyFormat)
dateTimeFriendlyFormat - the new date time friendly formatpublic void setDefaultValue(java.lang.String defaultValue)
defaultValue - the new default valuepublic void setDescription(java.lang.String description)
description - the new descriptionpublic void setDirection(Direction direction)
direction - the new directionpublic void setEditFormat(ChoiceFormatType editFormat)
editFormat - the new edits the formatpublic void setEnforceUniqueValues(boolean isEnforceUniqueValues)
isEnforceUniqueValues - the new enforce unique valuespublic void setFillInChoice(boolean fillInChoice)
fillInChoice - the new fill in choicepublic void setFormula(java.lang.String formula)
formula - the new formulapublic void setGridEndNumber(int gridEndNumber)
gridEndNumber - the new grid end numberpublic void setGridNonApplicableOptionText(java.lang.String gridNonApplicableOptionText)
gridNonApplicableOptionText - the new grid non applicable option textpublic void setGridStartNumber(int gridStartNumber)
gridStartNumber - the new grid start numberpublic void setGridTextRangeAverage(java.lang.String gridTextRangeAverage)
gridTextRangeAverage - the new grid text range averagepublic void setGridTextRangeHigh(java.lang.String gridTextRangeHigh)
gridTextRangeHigh - the new grid text range highpublic void setGridTextRangeLow(java.lang.String gridTextRangeLow)
gridTextRangeLow - the new grid text range lowpublic void setGroup(java.lang.String group)
group - the new grouppublic void setHidden(boolean isHidden)
isHidden - the new hiddenpublic void setIndexed(boolean isIndexed)
isIndexed - the new indexedpublic void setJSLink(java.lang.String jsLink)
jsLink - the new JS linkpublic void setLookupField(java.lang.String lookupField)
lookupField - the new lookup fieldpublic void setLookupList(java.lang.String lookupList)
lookupList - the new lookup listpublic void setLookupWebId(java.lang.String lookupWebId)
lookupWebId - the new lookup web idpublic void setMaximumLength(int maximumLength)
maximumLength - the new maximum lengthpublic void setMaximumValue(double maximumValue)
maximumValue - the new maximum valuepublic void setMinimumValue(double minimumValue)
minimumValue - the new minimum valuepublic void setNumberOfLines(int numberOfLines)
numberOfLines - the new number of linespublic void setOutputType(FieldType outputType)
outputType - the new output typepublic void setPrimaryFieldId(java.lang.String primaryFieldId)
primaryFieldId - the new primary field idpublic void setReadOnly(boolean isReadOnly)
isReadOnly - the new read onlypublic void setRelationship(boolean isRelationship)
isRelationship - the new relationshippublic void setRelationshipDeleteBehavior(RelationshipDeleteBehaviorType relationshipDeleteBehavior)
relationshipDeleteBehavior - the new relationship delete behaviorpublic void setRequired(boolean isRequired)
isRequired - the new requiredpublic void setRestrictedMode(boolean isRestrictedMode)
isRestrictedMode - the new restricted modepublic void setRichText(boolean isRichText)
isRichText - the new rich textpublic void setSchemaXml(FieldSchemaXml schemaXml)
schemaXml - the new schema xmlpublic void setScope(java.lang.String scope)
scope - the new scopepublic void setSealed(boolean isSealed)
isSealed - the new sealedpublic void setSelectionGroup(int selectionGroup)
selectionGroup - the new selection grouppublic void setSelectionMode(FieldUserSelectionMode selectionMode)
selectionMode - the new selection modepublic void setSortable(boolean isSortable)
isSortable - the new sortablepublic void setStaticName(java.lang.String staticName)
staticName - the new static namepublic void setTitle(java.lang.String title)
title - the new titlepublic void setType(FieldType type)
type - the new typepublic void setTypeAsString(java.lang.String typeAsString)
typeAsString - the new type as stringpublic void setUrlDisplayFormat(UrlFieldDisplayFormat urlDisplayFormat)
urlDisplayFormat - the new url display formatpublic void setValidationFormula(java.lang.String validationFormula)
validationFormula - the new validation formulapublic void setValidationMessage(java.lang.String validationMessage)
validationMessage - the new validation message