de.ipcon.db.core

Interface ParameterizedStrukturI

All Superinterfaces:

DescribableI

All Known Implementing Classes:

Alias, Codebaustein, Formular, Lesezeichen, Report, Schablone

public interface ParameterizedStrukturI
extends DescribableI

To be implemented by structures (Strukturen) that possess a "Parameter" attribute. This interface defines methods for accessing and manipulating this parameter in various forms, from raw storage to a fully processed representation suitable for UI. It extends DescribableI to ensure that implementing structures can provide a descriptive string representation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Method Summary

Modifier and Type	Method and Description
electric.xml.Document	getCookedParameter(CodebausteinStorageI cbss, StrukturParameterDefaultApplierI defaultApplier, java.lang.Object[] l10nPaths) Retrieves and returns the value of the "Parameter" property, after it has been fully processed.
boolean	getIstAutomatikNN() FIXME TH 2022-08-22: This method might be deprecated or removed.
java.lang.String	getParameter() Retrieves and returns the value of the "Parameter" property.
java.lang.String	getRawParameter() Simply retrieves and returns the raw, unprocessed value of the "Parameter" property.
boolean	isLazy() Checks if the parameter's value is currently in a lazy-loaded state.
boolean	istIstAutomatik() Checks if this Struktur is marked as "Automatik" (automatically created).
void	setParameter(java.lang.String param) Sets the value of the "Parameter" property.
void	unlazy() Forces the loading of the parameter's value if it is currently in a lazy-loaded state.

Methods inherited from interface de.ipcon.schema.DescribableI

collectDescribe, collectDescribe, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, describe, describe, describe, describe, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeNE, describeNE, join, join, join, notEmptyDescription

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

getCookedParameter

electric.xml.Document getCookedParameter(CodebausteinStorageI cbss,
                                         StrukturParameterDefaultApplierI defaultApplier,
                                         java.lang.Object[] l10nPaths)
                                  throws electric.xml.ParseException

Retrieves and returns the value of the "Parameter" property, after it has been fully processed. This includes performing include replacements, applying localization (l10n), and any other necessary preparations. This version should be used when the parameter value is intended for direct display or use in a GUI element.

Parameters:

cbss - The CodebausteinStorageI to use for resolving code module (Codebaustein) includes.

defaultApplier - The StrukturParameterDefaultApplierI to apply default values or transformations.

l10nPaths - An array of Objects representing localization paths to use for resolving l10n keys.

Returns:

A Document object representing the fully processed and "cooked" parameter value.

Throws:

electric.xml.ParseException - If an error occurs during parsing or processing of the parameter value.

getParameter

java.lang.String getParameter()

Retrieves and returns the value of the "Parameter" property. This version ensures the parameter is "unlazied" (i.e., its value is loaded if it is isLazy(), but without applying any further localization (l10n) or other complex preparations. This is useful when the raw, loaded string content is needed.

Returns:

A String representing the unlazied parameter value, without l10n or other processing.

getRawParameter

java.lang.String getRawParameter()

Simply retrieves and returns the raw, unprocessed value of the "Parameter" property. This version bypasses any unlazying, preparation, localization (l10n), or other transformations. It provides direct access to the parameter's stored string content.

Returns:

A String representing the raw parameter value as it is stored.

setParameter

void setParameter(java.lang.String param)

Sets the value of the "Parameter" property.

Parameters:

param - The String value to set for the "Parameter" property.

isLazy

boolean isLazy()

Checks if the parameter's value is currently in a lazy-loaded state. A lazy-loaded parameter means its actual content has not yet been loaded into memory.

Returns:

true if the parameter is lazy-loaded, false otherwise.

unlazy

void unlazy()

Forces the loading of the parameter's value if it is currently in a lazy-loaded state. After this method is called, isLazy() should return false.

getIstAutomatikNN

boolean getIstAutomatikNN()

FIXME TH 2022-08-22: This method might be deprecated or removed. Retrieves the non-null boolean value indicating whether this Struktur is "Automatik" (automatically created).

Returns:

true if the Struktur is "Automatik", false otherwise.

istIstAutomatik

boolean istIstAutomatik()

Checks if this Struktur is marked as "Automatik" (automatically created).

Returns:

true if the Struktur is "Automatik", false otherwise.