com.dotmarketing.portlets.structure.model
Class Field

java.lang.Object
  com.dotmarketing.beans.Inode
      com.dotmarketing.portlets.structure.model.Field

All Implemented Interfaces:

UUIDable, Permissionable, Versionable, Categorizable, java.io.Serializable, java.lang.Comparable

public class Field
extends Inode

See Also:

Serialized Form

Nested Class Summary

static class	Field.DataType
static class	Field.FieldType

Field Summary

Fields inherited from class com.dotmarketing.beans.Inode

inode, owner

Constructor Summary

Field()

Field(java.lang.String fieldName, Field.FieldType fieldType, Field.DataType dataType, Structure structure, boolean required, boolean listed, boolean indexed, int sortOrder, boolean fixed, boolean readOnly, boolean searchable)

Field(java.lang.String fieldName, Field.FieldType fieldType, Field.DataType dataType, Structure structure, boolean required, boolean listed, boolean indexed, int sortOrder, java.lang.String values, java.lang.String defaultValue, java.lang.String checkRegex, boolean fixed, boolean readOnly, boolean searchable)

Method Summary

void	delete()
java.lang.String	getDefaultValue()
java.lang.String	getFieldContentlet() Database name of the field (text1, text2, ..., date1, ...)
java.lang.String	getFieldName()
java.lang.String	getFieldRelationType()
java.lang.String	getFieldType()
java.lang.String	getHint()
java.util.Map<java.lang.String,java.lang.Object>	getMap() Returns a hashmap with all the inode fields
java.lang.String	getRegexCheck()
int	getSortOrder()
java.lang.String	getStructureInode()
java.lang.String	getValues()
java.lang.String	getVelocityVarName()
boolean	isFixed()
boolean	isIndexed()
boolean	isListed()
boolean	isReadOnly()
boolean	isRequired()
boolean	isSearchable()
boolean	isUnique()
void	setDefaultValue(java.lang.String defaultValue)
void	setFieldContentlet(java.lang.String fieldContentlet)
void	setFieldName(java.lang.String fieldName)
void	setFieldRelationType(java.lang.String fieldRelationType)
void	setFieldType(java.lang.String fieldType)
void	setFixed(boolean fixed)
void	setHint(java.lang.String hint)
void	setIndexed(boolean indexed)
void	setListed(boolean listed)
void	setReadOnly(boolean readOnly)
void	setRegexCheck(java.lang.String regexCheck)
void	setRequired(boolean required)
void	setSearchable(boolean searchable)
void	setSortOrder(int sortOrder)
void	setStructureInode(java.lang.String structureInode)
void	setUnique(boolean unique)
void	setValues(java.lang.String values)
void	setVelocityVarName(java.lang.String velocityVarName)

Methods inherited from class com.dotmarketing.beans.Inode

acceptedPermissions, addChild, addChild, addChild, addParent, addParent, compareTo, deleteChild, deleteChild, deleteParent, deleteParent, equals, getCategoryId, getiDate, getIDate, getIdentifier, getInode, getModDate, getModUser, getOwner, getParentPermissionable, getPermissionId, getPermissionType, getTitle, getType, getVersionId, getVersionType, hasChildren, hashCode, hasParents, isArchived, isLive, isLocked, isNew, isParentPermissionable, isWorking, permissionDependencies, setiDate, setIDate, setIDate, setIdentifier, setInode, setOwner, setParents, setType, setVersionId

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field()

Field

public Field(java.lang.String fieldName,
             Field.FieldType fieldType,
             Field.DataType dataType,
             Structure structure,
             boolean required,
             boolean listed,
             boolean indexed,
             int sortOrder,
             boolean fixed,
             boolean readOnly,
             boolean searchable)

Field

public Field(java.lang.String fieldName,
             Field.FieldType fieldType,
             Field.DataType dataType,
             Structure structure,
             boolean required,
             boolean listed,
             boolean indexed,
             int sortOrder,
             java.lang.String values,
             java.lang.String defaultValue,
             java.lang.String checkRegex,
             boolean fixed,
             boolean readOnly,
             boolean searchable)

Method Detail

getFieldContentlet

public java.lang.String getFieldContentlet()

Database name of the field (text1, text2, ..., date1, ...)

Returns:

setFieldContentlet

public void setFieldContentlet(java.lang.String fieldContentlet)

getFieldName

public java.lang.String getFieldName()

setFieldName

public void setFieldName(java.lang.String fieldName)

getFieldRelationType

public java.lang.String getFieldRelationType()

setFieldRelationType

public void setFieldRelationType(java.lang.String fieldRelationType)

getFieldType

public java.lang.String getFieldType()

setFieldType

public void setFieldType(java.lang.String fieldType)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getSortOrder

public int getSortOrder()

setSortOrder

public void setSortOrder(int sortOrder)

getStructureInode

public java.lang.String getStructureInode()

setStructureInode

public void setStructureInode(java.lang.String structureInode)

getValues

public java.lang.String getValues()

setValues

public void setValues(java.lang.String values)

getVelocityVarName

public java.lang.String getVelocityVarName()

setVelocityVarName

public void setVelocityVarName(java.lang.String velocityVarName)

getRegexCheck

public java.lang.String getRegexCheck()

setRegexCheck

public void setRegexCheck(java.lang.String regexCheck)

getDefaultValue

public java.lang.String getDefaultValue()

Returns:

Returns the defaultValue.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Parameters:

defaultValue - The defaultValue to set.

getHint

public java.lang.String getHint()

Returns:

Returns the hint.

setHint

public void setHint(java.lang.String hint)

Parameters:

hint - The hint to set.

delete

public void delete()

isIndexed

public boolean isIndexed()

setIndexed

public void setIndexed(boolean indexed)

isListed

public boolean isListed()

setListed

public void setListed(boolean listed)

isFixed

public boolean isFixed()

setFixed

public void setFixed(boolean fixed)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()

Description copied from class: Inode

Returns a hashmap with all the inode fields

Overrides:

getMap in class Inode

Returns:

the map

isSearchable

public boolean isSearchable()

setSearchable

public void setSearchable(boolean searchable)

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean unique)