com.laserfiche.repository.api.clients.impl.model

Class WFieldInfo

java.lang.Object

com.laserfiche.repository.api.clients.impl.model.WFieldInfo

Direct Known Subclasses:

TemplateFieldInfo

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen")
public class WFieldInfo
extends Object

Constructor Summary

Constructors

Constructor and Description
WFieldInfo()

Method Summary

Modifier and Type	Method and Description
WFieldInfo	addListValuesItem(String listValuesItem)
WFieldInfo	constraint(String constraint)
WFieldInfo	constraintError(String constraintError)
WFieldInfo	currency(String currency)
WFieldInfo	defaultValue(String defaultValue)
WFieldInfo	description(String description)
WFieldInfo	displayName(String displayName)
boolean	equals(Object o)
WFieldInfo	fieldType(WFieldType fieldType)
WFieldInfo	format(WFieldFormat format)
WFieldInfo	formatPattern(String formatPattern)
String	getConstraint() Returns the constraint for values stored in the represented field.
String	getConstraintError() Returns the error string that will be returned when the field constraint is violated when setting a value for this field.
String	getCurrency() Returns the name of the currency that will be using when formatting the represented field when the Format property is set to the Currency member of the WFieldFormat enumeration.
String	getDefaultValue() Returns the default value of the field for new entries that are assigned to a template the represented field is a member of.
String	getDescription() Returns the description of the field.
String	getDisplayName() Returns the localized name of the field.
WFieldType	getFieldType() Returns fieldType
WFieldFormat	getFormat() Returns format
String	getFormatPattern() Returns the custom format pattern for fields that are configured to use a custom format.
Integer	getId() Returns the ID of the field.
Integer	getLength() Returns the length of the field for variable length data types.
List<String>	getListValues() Returns the list of items assigned to the represented field.
String	getName() Returns the name of the field.
int	hashCode()
WFieldInfo	id(Integer id)
Boolean	isMultiValue() Returns a boolean indicating if the represented template field supports multiple values.
WFieldInfo	isMultiValue(Boolean isMultiValue)
Boolean	isRequired() Returns a boolean indicating if the represented field must have a value set on entries assigned to a template that the field is a member of.
WFieldInfo	isRequired(Boolean isRequired)
WFieldInfo	length(Integer length)
WFieldInfo	listValues(List<String> listValues)
WFieldInfo	name(String name)
void	setConstraint(String constraint)
void	setConstraintError(String constraintError)
void	setCurrency(String currency)
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setFieldType(WFieldType fieldType)
void	setFormat(WFieldFormat format)
void	setFormatPattern(String formatPattern)
void	setId(Integer id)
void	setIsMultiValue(Boolean isMultiValue)
void	setIsRequired(Boolean isRequired)
void	setLength(Integer length)
void	setListValues(List<String> listValues)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WFieldInfo

public WFieldInfo()

Method Detail

name

public WFieldInfo name(String name)

getName

public String getName()

Returns the name of the field.

Returns:

name

setName

public void setName(String name)

displayName

public WFieldInfo displayName(String displayName)

getDisplayName

public String getDisplayName()

Returns the localized name of the field.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

id

public WFieldInfo id(Integer id)

getId

public Integer getId()

Returns the ID of the field.

Returns:

id

setId

public void setId(Integer id)

description

public WFieldInfo description(String description)

getDescription

public String getDescription()

Returns the description of the field.

Returns:

description

setDescription

public void setDescription(String description)

fieldType

public WFieldInfo fieldType(WFieldType fieldType)

getFieldType

public WFieldType getFieldType()

Returns fieldType

Returns:

fieldType

setFieldType

public void setFieldType(WFieldType fieldType)

length

public WFieldInfo length(Integer length)

getLength

public Integer getLength()

Returns the length of the field for variable length data types.

Returns:

length

setLength

public void setLength(Integer length)

defaultValue

public WFieldInfo defaultValue(String defaultValue)

getDefaultValue

public String getDefaultValue()

Returns the default value of the field for new entries that are assigned to a template the represented field is a member of.

Returns:

defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

isMultiValue

public WFieldInfo isMultiValue(Boolean isMultiValue)

isMultiValue

public Boolean isMultiValue()

Returns a boolean indicating if the represented template field supports multiple values.

Returns:

isMultiValue

setIsMultiValue

public void setIsMultiValue(Boolean isMultiValue)

isRequired

public WFieldInfo isRequired(Boolean isRequired)

isRequired

public Boolean isRequired()

Returns a boolean indicating if the represented field must have a value set on entries assigned to a template that the field is a member of.

Returns:

isRequired

setIsRequired

public void setIsRequired(Boolean isRequired)

constraint

public WFieldInfo constraint(String constraint)

getConstraint

public String getConstraint()

Returns the constraint for values stored in the represented field.

Returns:

constraint

setConstraint

public void setConstraint(String constraint)

constraintError

public WFieldInfo constraintError(String constraintError)

getConstraintError

public String getConstraintError()

Returns the error string that will be returned when the field constraint is violated when setting a value for this field.

Returns:

constraintError

setConstraintError

public void setConstraintError(String constraintError)

listValues

public WFieldInfo listValues(List<String> listValues)

addListValuesItem

public WFieldInfo addListValuesItem(String listValuesItem)

getListValues

public List<String> getListValues()

Returns the list of items assigned to the represented field.

Returns:

listValues

setListValues

public void setListValues(List<String> listValues)

format

public WFieldInfo format(WFieldFormat format)

getFormat

public WFieldFormat getFormat()

Returns format

Returns:

format

setFormat

public void setFormat(WFieldFormat format)

currency

public WFieldInfo currency(String currency)

getCurrency

public String getCurrency()

Returns the name of the currency that will be using when formatting the represented field when the Format property is set to the Currency member of the WFieldFormat enumeration.

Returns:

currency

setCurrency

public void setCurrency(String currency)

formatPattern

public WFieldInfo formatPattern(String formatPattern)

getFormatPattern

public String getFormatPattern()

Returns the custom format pattern for fields that are configured to use a custom format.

Returns:

formatPattern

setFormatPattern

public void setFormatPattern(String formatPattern)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object