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

Class GomIncludeContent

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList<GomIncludeContent.LabelContentSource>

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

All Implemented Interfaces:

OptionFactoryProvider, GomCheckable, GomElement, GomIncludeConfiguration, GomList<GomIncludeContent.LabelContentSource>, Serializable, Cloneable, Iterable<GomIncludeContent.LabelContentSource>, Collection<GomIncludeContent.LabelContentSource>, List<GomIncludeContent.LabelContentSource>, RandomAccess

@Deprecated(since="4.2.414")
@NonExtendable
public class GomIncludeContent
extends AbstractGomList<GomIncludeContent.LabelContentSource>
implements GomIncludeConfiguration, OptionFactoryProvider, GomCheckable

Deprecated.

since 4.2.414 use GomIncludeOptions instead

GOM definition for content inclusion. The enumeration GomIncludeContent.Type defines the supported types of includes.

Since:

4.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GomIncludeContent.LabelContentSource	Deprecated. Content-based source definition for providing a language-dependent label
static enum	GomIncludeContent.Type	Deprecated. Supported include types

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

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	Deprecated. The tag of this component

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
GomIncludeContent()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Deprecated. Returns the default tag name of the component.
Map<String,Class<? extends GomElement>>	getGomElementMappings()	Deprecated. Get a list of mappings from tag name to class supported by this list.
String	getGuiXml()	Deprecated. Get the GuiXML to be included.
String	getKey()	Deprecated. Optional key providing the entry identifying value
OptionFactory	getOptionFactory()	Deprecated. Get a factory for accessing options defined by the include mechanism.
TableTemplateReference	getTable()	Deprecated. Reference to the table template
GomIncludeContent.Type	getType()	Deprecated. Type for content inclusion
void	setKey(String primary)	Deprecated. Sets the key providing the entry identifying value
void	setTable(TableTemplateReference table)	Deprecated. Sets the reference to the table template
void	setType(GomIncludeContent.Type type)	Deprecated. Sets the type for content inclusion
void	validate(GomCheckable.Context context)	Deprecated. Validate the element against the given context.
void	verify()	Deprecated. Check if the list is marked as mandatory (not inherited!)

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

TAG

public static final String TAG

Deprecated.

The tag of this component

Since:

4.0

See Also:

• Constant Field Values

Constructor Details

GomIncludeContent

public GomIncludeContent()

Deprecated.

Method Details

getDefaultTag

protected String getDefaultTag()

Deprecated.

Description copied from class: AbstractGomList

Returns the default tag name of the component.

Specified by:

getDefaultTag in class AbstractGomList<GomIncludeContent.LabelContentSource>

getType

public GomIncludeContent.Type getType()

Deprecated.

Type for content inclusion

Since:

4.0

setType

public void setType(GomIncludeContent.Type type)

Deprecated.

Sets the type for content inclusion

Since:

4.0

getTable

public TableTemplateReference getTable()

Deprecated.

Reference to the table template

Since:

4.0

setTable

public void setTable(TableTemplateReference table)

Deprecated.

Sets the reference to the table template

Since:

4.0

getKey

public String getKey()

Deprecated.

Optional key providing the entry identifying value

Since:

4.0

setKey

public void setKey(String primary)

Deprecated.

Sets the key providing the entry identifying value

Since:

4.0

getGuiXml

public String getGuiXml()

Deprecated.

Description copied from interface: GomIncludeConfiguration

Get the GuiXML to be included.

Specified by:

getGuiXml in interface GomIncludeConfiguration

Returns:

The included GuiXML.

verify

public void verify()
            throws IllegalStateException

Deprecated.

Description copied from class: AbstractGomList

Check if the list is marked as mandatory (not inherited!) and not empty

Specified by:

verify in interface GomCheckable

Overrides:

verify in class AbstractGomList<GomIncludeContent.LabelContentSource>

Throws:

IllegalStateException - If the element is not correctly set up.

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Deprecated.

Description copied from interface: GomCheckable

Validate the element against the given context.

Specified by:

validate in interface GomCheckable

Parameters:

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

Throws:

GomValidationError - If the element is not plausible wrt. its context.

getGomElementMappings

public Map<String,Class<? extends GomElement>> getGomElementMappings()

Deprecated.

Description copied from interface: GomList

Get a list of mappings from tag name to class supported by this list.

Convention:

The mapping shall only be created on demand and not change at runtime.

Specified by:

getGomElementMappings in interface GomList<GomIncludeContent.LabelContentSource>

Overrides:

getGomElementMappings in class AbstractGomList<GomIncludeContent.LabelContentSource>

Returns:

The list of child tags.

getOptionFactory

public OptionFactory getOptionFactory()

Deprecated.

Get a factory for accessing options defined by the include mechanism.

Specified by:

getOptionFactory in interface OptionFactoryProvider

Returns:

The factory.