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

Class FieldDefinition

java.lang.Object

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

Direct Known Subclasses:

TemplateFieldDefinition

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

Represents a field definition.

Constructor Summary

Constructors

Constructor and Description
FieldDefinition()

Method Summary

Modifier and Type	Method and Description
FieldDefinition	addListValuesItem(String listValuesItem)
FieldDefinition	constraint(String constraint)
FieldDefinition	constraintError(String constraintError)
FieldDefinition	currency(String currency)
FieldDefinition	defaultValue(String defaultValue)
FieldDefinition	description(String description)
FieldDefinition	displayName(String displayName)
boolean	equals(Object o)
FieldDefinition	fieldType(FieldType fieldType)
FieldDefinition	format(FieldFormat format)
FieldDefinition	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.
FieldType	getFieldType() Returns fieldType
FieldFormat	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()
FieldDefinition	id(Integer id)
Boolean	isMultiValue() Returns a boolean indicating if the represented template field supports multiple values.
FieldDefinition	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.
FieldDefinition	isRequired(Boolean isRequired)
FieldDefinition	length(Integer length)
FieldDefinition	listValues(List<String> listValues)
FieldDefinition	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(FieldType fieldType)
void	setFormat(FieldFormat 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

FieldDefinition

public FieldDefinition()

Method Detail

name

public FieldDefinition name(String name)

getName

public String getName()

Returns the name of the field.

Returns:

name

setName

public void setName(String name)

displayName

public FieldDefinition displayName(String displayName)

getDisplayName

public String getDisplayName()

Returns the localized name of the field.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

id

public FieldDefinition id(Integer id)

getId

public Integer getId()

Returns the ID of the field.

Returns:

id

setId

public void setId(Integer id)

description

public FieldDefinition description(String description)

getDescription

public String getDescription()

Returns the description of the field.

Returns:

description

setDescription

public void setDescription(String description)

fieldType

public FieldDefinition fieldType(FieldType fieldType)

getFieldType

public FieldType getFieldType()

Returns fieldType

Returns:

fieldType

setFieldType

public void setFieldType(FieldType fieldType)

length

public FieldDefinition 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 FieldDefinition 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 FieldDefinition 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 FieldDefinition 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 FieldDefinition 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 FieldDefinition 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 FieldDefinition listValues(List<String> listValues)

addListValuesItem

public FieldDefinition 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 FieldDefinition format(FieldFormat format)

getFormat

public FieldFormat getFormat()

Returns format

Returns:

format

setFormat

public void setFormat(FieldFormat format)

currency

public FieldDefinition 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 FieldDefinition 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