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

Class GomTemplateReferenceEntry

java.lang.Object

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

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

All Implemented Interfaces:

GomCheckable, GomElement, GomUidProviding, GomUidTypeProviding, Serializable

@NonExtendable
public class GomTemplateReferenceEntry
extends AbstractGomElement
implements GomCheckable, GomUidProviding, GomUidTypeProviding

Entry for identifier lists.

Since:

4.0

See Also:

• Serialized Form

Nested Class Summary

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	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomTemplateReferenceEntry(String name)	Convenient constructor.

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Return the default tag for a gom element.
ReferenceName	getName()	The actual reference name
@Nullable String	getUid()	The UID this element holds as a reference.
IDProvider.UidType	getUidType()	The IDProvider.UidType of the references contained.
String	name()	Convenience method for getName() returning a simple String
void	setName(ReferenceName name)	Sets the actual reference name
void	validate(GomCheckable.Context context)	Validate the element against the given context.
void	verify()	Verify the element to be fulfill its syntactic constraints.

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.0

See Also:

• Constant Field Values

Constructor Details

GomTemplateReferenceEntry

public GomTemplateReferenceEntry(String name)

Convenient constructor.

Parameters:

name - The reference name to set.

Since:

4.0

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getName

public ReferenceName getName()

The actual reference name

Since:

3.0

setName

public void setName(ReferenceName name)

Sets the actual reference name

Since:

3.0

getUidType

@Nullable
public IDProvider.UidType getUidType()

Description copied from interface: GomUidTypeProviding

The IDProvider.UidType of the references contained.

Specified by:

getUidType in interface GomUidTypeProviding

Returns:

The associated uid type.

getUid

@Nullable
public @Nullable String getUid()

Description copied from interface: GomUidProviding

The UID this element holds as a reference.

Specified by:

getUid in interface GomUidProviding

Returns:

The UID or null.

name

public String name()

Convenience method for getName() returning a simple String

Since:

3.0

verify

public void verify()
            throws IllegalStateException

Description copied from interface: GomCheckable

Verify the element to be fulfill its syntactic constraints.

Specified by:

verify in interface GomCheckable

Throws:

IllegalStateException - If the element is not correctly set up.

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

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.