Package de.espirit.firstspirit.access.store.templatestore.gom

Class AbstractGomTableTemplateElement

java.lang.Object

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomTableTemplateElement

All Implemented Interfaces:

GomCheckable, GomElement, GomFormElement, GomHideable, GomIndexTreatment, GomLangInfoProvider, GomSearchRelevancy, GomTableTemplateProvider, LineBreakable, Serializable

Direct Known Subclasses:

AbstractGomContentReferenceElement, GomContentList

@NonExtendable
public abstract class AbstractGomTableTemplateElement
extends AbstractGomFormElement
implements GomTableTemplateProvider, GomIndexTreatment

Abstract base class for TableTemplate elements.

Since:

3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Constructor Summary

Constructors

Constructor	Description
AbstractGomTableTemplateElement()

Method Summary

Modifier and Type	Method	Description
Treatment	getIndexTreatment()	Provides the treatment option for following associations.
TableTemplateReference	getTable()	Reference to the table template
void	setIndexTreatment(@Nullable Treatment treatment)	Sets the treatment option for following associations.
void	setTable(TableTemplateReference table)	Sets the reference to the table template
static @NotNull TableTemplate	validate(@NotNull GomCheckable.Context context, @NotNull TableTemplateReference table, @NotNull GomElement gomElement)	Validates a form element
void	validate(GomCheckable.Context context)	Validates the form element's state with respect to the given context.
static @NotNull TableTemplate	validateTableTemplate(@NotNull GomCheckable.Context context, @NotNull TableTemplateReference table, @NotNull GomElement gomElement)	Validates a table template
void	verify()	Verifies the form element's state.

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getDefaultTag, getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Constructor Details

AbstractGomTableTemplateElement

public AbstractGomTableTemplateElement()

Method Details

getTable

public TableTemplateReference getTable()

Description copied from interface: GomTableTemplateProvider

Reference to the table template

Specified by:

getTable in interface GomTableTemplateProvider

setTable

public void setTable(TableTemplateReference table)

Description copied from interface: GomTableTemplateProvider

Sets the reference to the table template

Specified by:

setTable in interface GomTableTemplateProvider

getIndexTreatment

public Treatment getIndexTreatment()

Provides the treatment option for following associations.

Specified by:

getIndexTreatment in interface GomIndexTreatment

Returns:

The desired indexing treatment.

Since:

5.2.12

setIndexTreatment

public void setIndexTreatment(@Nullable
 @Nullable Treatment treatment)

Sets the treatment option for following associations.

Specified by:

setIndexTreatment in interface GomIndexTreatment

Parameters:

treatment - The treatment to be used.

Since:

5.2.12

verify

public void verify()
            throws IllegalStateException

Description copied from class: AbstractGomFormElement

Verifies the form element's state. In this generic part, checks for the required name and language information.

Specified by:

verify in interface GomCheckable

Overrides:

verify in class AbstractGomFormElement

Throws:

IllegalStateException - if any requirement is violated.

validate

public void validate(GomCheckable.Context context)
              throws IllegalStateException

Description copied from class: AbstractGomFormElement

Validates the form element's state with respect to the given context. This generic stub does not check anything.

Specified by:

validate in interface GomCheckable

Overrides:

validate in class AbstractGomFormElement

Parameters:

context - The context to validate for, must not be null.

Throws:

IllegalStateException

validate

@NotNull
public static @NotNull TableTemplate validate(@NotNull
 @NotNull GomCheckable.Context context,
 @NotNull
 @NotNull TableTemplateReference table,
 @NotNull
 @NotNull GomElement gomElement)

Validates a form element

Throws:

GomValidationError - if the form element is not valid

Since:

5.0

validateTableTemplate

@NotNull
public static @NotNull TableTemplate validateTableTemplate(@NotNull
 @NotNull GomCheckable.Context context,
 @NotNull
 @NotNull TableTemplateReference table,
 @NotNull
 @NotNull GomElement gomElement)

Validates a table template

Returns:

the validated template.

Throws:

GomValidationError - if the table template is not valid.

Since:

4.2.5