de.ipcon.db.core

Class Codebaustein

java.lang.Object

de.ipcon.db.core.Transliterator

de.ipcon.db.core.Synchable

de.ipcon.db.core.BO

de.ipcon.db.core.CoreBOBase

de.ipcon.db.core.CoreBO

de.ipcon.db.core.BenanntBase

de.ipcon.db.core.Benannt

de.ipcon.db.core.StrukturBase

de.ipcon.db.core.Struktur

de.ipcon.db.core.CodebausteinBase

de.ipcon.db.core.Codebaustein

All Implemented Interfaces:

LazyDataProviderI, NotificationAttachmentI, ParameterizedStrukturI, SaveAwareI, SaveVetoI, TransliteratorI, XMLExportableI, BOI, DescribableI, Identifiable, SchemaProviderI, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class Codebaustein
extends de.ipcon.db.core.CodebausteinBase
implements ParameterizedStrukturI

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.ipcon.db.core.Struktur

Struktur.ClientPrioComparator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENTNAME
static java.lang.String	FsExtension
static java.lang.String	PARAMNAME_OPTIONAL
static java.lang.String	PARAMNAME_USEFALLBACK
static java.util.regex.Pattern	pattern
static java.lang.String	PATTERN_POSTFIX
static java.lang.String	PATTERN_PREFIX

Fields inherited from class de.ipcon.db.core.CodebausteinBase

ATT_Argumente, ATT_BenutztInStrukturen, ATT_IncludeElementText, ATT_Parameter, ENT_Codebaustein

Fields inherited from class de.ipcon.db.core.Struktur

allowAutomatikModification, clientPrioComparator, EMPTY_ARRAY

Fields inherited from class de.ipcon.db.core.StrukturBase

ATT_Aliase, ATT_AlleAliase, ATT_AsStrukturInIssueReports, ATT_Codebausteine, ATT_Dateiname, ATT_Elter, ATT_ElterFilter, ATT_ElterPfad, ATT_Farbe, ATT_IstAutomatik, ATT_Lesezugriffe, ATT_Position, ATT_ResolvedName, ATT_SichtbarFuerGruppen, ATT_SichtbarFuerGruppenHatEintraege, ATT_Sichtbarkeitsskript, ATT_Tid, ENT_Struktur

Fields inherited from class de.ipcon.db.core.BenanntBase

ATT_Beschreibung, ATT_KinderRefs, ATT_L10nBeschreibung, ATT_L10nName, ATT_Name, ENT_Benannt

Fields inherited from class de.ipcon.db.core.CoreBOBase

ATT_AlsAntwortAnBeiAuftraegen, ATT_AlsEmpfaengerBCCBeiAuftraegen, ATT_AlsEmpfaengerBeiAuftraegen, ATT_AlsEmpfaengerCCBeiAuftraegen, ATT_AlsKontextBOBeiAuftraegen, ATT_WirdAlsAntwortAnVerwendetBeiAlarmen, ATT_WirdBenachrichtigtBCCBeiAlarm, ATT_WirdBenachrichtigtBeiAlarm, ATT_WirdBenachrichtigtCCBeiAlarm, ENT_CoreBO

Fields inherited from class de.ipcon.db.core.BO

BLOB_KEY, CANCEL_RECALC_CALLED, D_0, D_1, D_10, D_100, D_1000, D_10000, D_5, D_MINUS_1, D_MINUS_ONE, D_ONE, D_ZERO, doExWriteLRMFunction, F_0, F_1, L_0, L10N_KEY_BO_INSTANTIATION, L10N_KEY_BO_WITH_PROTECTED_CONSTRUCTOR, NULL_AGGREGATE, NULL_ITERATOR

Fields inherited from interface de.ipcon.schema.BOI

ATT_Badge, ATT_Badge2, ATT_Badge3, ATT_Badge4, ATT_BLOBCreatedBy, ATT_BLOBCreatedOn, ATT_BLOBDeletedBy, ATT_BLOBDeletedOn, ATT_BLOBLastModifiedBy, ATT_BLOBLastModifiedOn, ATT_Bot, ATT_Crea, ATT_CreatedBy, ATT_CreatedModifiedText, ATT_Id, ATT_InvolvedInProcs, ATT_LastModifiedBy, ATT_Ldel, ATT_Lmod, ATT_Procs, ENT_BO

Constructor Summary

Constructors

Constructor and Description
Codebaustein()

Method Summary

Modifier and Type	Method and Description
BO	createCopy() Creates a copy of this BO.
BO	createCopy(Transaction tx)
void	exportToImpl(FilesystemObject fso, EntityI ent, electric.xml.Element root)
java.util.Map<java.lang.Long,Struktur>	getBenutztInStrukturen()
java.lang.String	getCookedParameter()
electric.xml.Document	getCookedParameter(CodebausteinStorageI cbs, StrukturParameterDefaultApplierI defaultApplier, java.lang.Object[] l10nPaths) Retrieves and returns the value of the "Parameter" property, after it has been fully processed.
static FilesystemObject	getFsoForFile(java.io.File baseDir, java.io.File f, java.lang.String name, boolean forceOneFile)
java.lang.String	getIncludeElementText() Generates a include command displayed in the View 'Sonstiges' of the Codebaustein.
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.
java.util.Map	getRelationsForDateiSystemSyncCache()
void	importFromXML(EntityI ent, electric.xml.Element root, java.util.Map<java.lang.String,Benannt> mapElterCache, UnresolvedReferencesResolver urr, boolean asAutomatik, boolean keepValueIfXMLNotFound, boolean allowAutomatik)
static void	initEnvironment(Transaction tx, UnresolvedReferencesResolver urr)
static void	initEnvironment(Transaction tx, UnresolvedReferencesResolver urr, boolean authoritative)
boolean	isLazy() Checks if the parameter's value is currently in a lazy-loaded state.
boolean	isMandatory(AttributeI attr) Tells if the passed AttributeI is mandatory in the context of this BO (for the UI and access via the schema).
boolean	isReadOnly(AttributeI attr) Tells if the passed AttributeI is read-only in the context of this BO (for the UI and access via the schema).
java.lang.String	replaceArguments(java.lang.String withPlaceholders, java.util.List<java.lang.String> listIncs, java.util.Map<java.lang.String,java.lang.String> mapArgValues) Replaces the CBA placeholders with their appropriate value given via _mapArgValues.
void	setParameter(java.lang.String str) Sets the value of the "Parameter" property.
java.lang.String	toString()
void	unlazy() Forces the loading of the parameter's value if it is currently in a lazy-loaded state.
void	verifyOnClient(BasicClientContextI ctx)

Methods inherited from class de.ipcon.db.core.CodebausteinBase

addArgument, copyFrom, copyFrom, equalPayload, getArgumente, getArgumenteIterator, getBenutztInStrukturenIterator, getIncludeElementTextNE, getIncludeElementTextNN, getIncludeElementTextNN, getParameterNE, getParameterNN, getParameterNN, needIncludeElementText, needParameter, needPopulatedArgumente, needPopulatedBenutztInStrukturen, pgetArgumenteLazy, readExternal, removeArgument, setArgumente, setBOLoader, slim, slim, writeExternal

Methods inherited from class de.ipcon.db.core.Struktur

action_autoSetDateiname, action_autoSetTID, action_export_legacy, action_import_legacy, adaptForCaching, afterVerifyOnServer, cancelCheckConstraints, checkFSExportPrerequisites, collectChildren, collectChildren, collectChildren, collectChildren, compareClientPrioTo, cookParameter, cookParameter, cookParameter, createFilename, createFilename, createTID, delete, deleteOrphanedStrukturElemente, exportTo, getAlleAliase, getAlleAliase, getAsStrukturInIssueReports, getBenanntByElterPfad, getBenanntByElterPfad, getCacheElement, getCodebausteine, getCompiledSichtbarkeitsskript, getElterFilter, getElterNodes, getElterNodes, getElterNodes, getElterPfad, getFittingEST, getFQName, getMeinPfad, getMeinPfad, getPairStorage, getParameter, getRelationsForDateiSystemSync, getResolvedL10nName, getResolvedName, getResolvedNameNN, getSelfAndAllAliases, getSelfAndAllAliases, hasChild, hasElter, importFrom, initEnvironment, isDescendantOf, isDescendantOf, isDescendantOf, isDescendantOf, isPartOfUserEditArea, istRootOrAutomatik, isXMLValid, lazy, lazyImpl, loadResourceIndex, loadXMLDocumentFromResource, loadXMLDocumentFromResource, outputIntoElement, outputIntoElement, setCacheElement, setCodebausteine, setElter, setElterPfad, setElterPfad, setElterPfad, setName, setSichtbarkeitsskript, unlazyAutomatik, unlazyImpl, verifyOnServer

Methods inherited from class de.ipcon.db.core.StrukturBase

addAlias, addLesezugriffe, addSichtbarFuerGruppe, getAliase, getAliaseIterator, getAlleAliaseIterator, getAsStrukturInIssueReportsIterator, getCodebausteineIterator, getDateiname, getDateinameNE, getDateinameNN, getDateinameNN, getElter, getElterFilterNE, getElterFilterNN, getElterFilterNN, getElterPfadNE, getElterPfadNN, getElterPfadNN, getFarbe, getFarbeNE, getFarbeNN, getFarbeNN, getIstAutomatik, getIstAutomatikNN, getIstAutomatikNN, getLesezugriffe, getLesezugriffeIterator, getPosition, getPositionNN, getPositionNN, getResolvedNameNE, getResolvedNameNN, getSichtbarFuerGruppen, getSichtbarFuerGruppenHatEintraege, getSichtbarFuerGruppenHatEintraegeNN, getSichtbarFuerGruppenHatEintraegeNN, getSichtbarFuerGruppenIterator, getSichtbarkeitsskript, getSichtbarkeitsskriptNE, getSichtbarkeitsskriptNN, getSichtbarkeitsskriptNN, getTid, getTidNE, getTidNN, getTidNN, istIstAutomatik, istSichtbarFuerGruppenHatEintraege, needDateiname, needElter, needElterFilter, needElterPfad, needFarbe, needIstAutomatik, needPopulatedAliase, needPopulatedAlleAliase, needPopulatedAsStrukturInIssueReports, needPopulatedCodebausteine, needPopulatedLesezugriffe, needPopulatedSichtbarFuerGruppen, needPosition, needResolvedName, needSichtbarFuerGruppenHatEintraege, needSichtbarkeitsskript, needTid, pgetAliaseLazy, pgetLesezugriffeLazy, pgetSichtbarFuerGruppenLazy, removeAlias, removeLesezugriffe, removeSichtbarFuerGruppe, setAliase, setDateiname, setFarbe, setIstAutomatik, setLesezugriffe, setPosition, setSichtbarFuerGruppen, setSichtbarFuerGruppenHatEintraege, setTid

Methods inherited from class de.ipcon.db.core.Benannt

compareTo, createTID, createTID, getL10nBeschreibung, getL10nName, inputAsBenanntRelation, inputAsBenanntRelation, inputAsBenanntRelation, inputAsBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiRelation, inputAsMultiRelation, inputAsMultiRelation, inputAsRelation, inputAsRelation, inputAsRelation, inputAsRelation, outputAsBenanntRelation, outputAsBenanntRelation, outputAsMultiBenanntRelation, outputAsMultiBenanntRelation, outputAsMultiRelation, outputAsMultiRelation, outputAsRelation, outputAsRelation, outputAsRelation, outputBOTName, storePreparedRelationQueryResult

Methods inherited from class de.ipcon.db.core.BenanntBase

addKinderRef, getBeschreibung, getBeschreibungNE, getBeschreibungNN, getBeschreibungNN, getKinderRefs, getKinderRefsIterator, getL10nBeschreibungNE, getL10nBeschreibungNN, getL10nBeschreibungNN, getL10nNameNE, getL10nNameNN, getL10nNameNN, getName, getNameNE, getNameNN, getNameNN, needBeschreibung, needL10nBeschreibung, needL10nName, needName, needPopulatedKinderRefs, pgetKinderRefsLazy, removeKinderRef, setBeschreibung, setKinderRefs

Methods inherited from class de.ipcon.db.core.CoreBOBase

addAlsAntwortAnBeiAuftrag, addAlsEmpfaengerBCCBeiAuftrag, addAlsEmpfaengerBeiAuftrag, addAlsEmpfaengerCCBeiAuftrag, addAlsKontextBOBeiAuftrag, addWirdAlsAntwortAnVerwendetBeiAlarm, addWirdBenachrichtigtBCCBeiAlarm, addWirdBenachrichtigtBeiAlarm, addWirdBenachrichtigtCCBeiAlarm, getAlsAntwortAnBeiAuftraegen, getAlsAntwortAnBeiAuftraegenIterator, getAlsEmpfaengerBCCBeiAuftraegen, getAlsEmpfaengerBCCBeiAuftraegenIterator, getAlsEmpfaengerBeiAuftraegen, getAlsEmpfaengerBeiAuftraegenIterator, getAlsEmpfaengerCCBeiAuftraegen, getAlsEmpfaengerCCBeiAuftraegenIterator, getAlsKontextBOBeiAuftraegen, getAlsKontextBOBeiAuftraegenIterator, getWirdAlsAntwortAnVerwendetBeiAlarmen, getWirdAlsAntwortAnVerwendetBeiAlarmenIterator, getWirdBenachrichtigtBCCBeiAlarm, getWirdBenachrichtigtBCCBeiAlarmIterator, getWirdBenachrichtigtBeiAlarm, getWirdBenachrichtigtBeiAlarmIterator, getWirdBenachrichtigtCCBeiAlarm, getWirdBenachrichtigtCCBeiAlarmIterator, needPopulatedAlsAntwortAnBeiAuftraegen, needPopulatedAlsEmpfaengerBCCBeiAuftraegen, needPopulatedAlsEmpfaengerBeiAuftraegen, needPopulatedAlsEmpfaengerCCBeiAuftraegen, needPopulatedAlsKontextBOBeiAuftraegen, needPopulatedWirdAlsAntwortAnVerwendetBeiAlarmen, needPopulatedWirdBenachrichtigtBCCBeiAlarm, needPopulatedWirdBenachrichtigtBeiAlarm, needPopulatedWirdBenachrichtigtCCBeiAlarm, pgetAlsAntwortAnBeiAuftraegenLazy, pgetAlsEmpfaengerBCCBeiAuftraegenLazy, pgetAlsEmpfaengerBeiAuftraegenLazy, pgetAlsEmpfaengerCCBeiAuftraegenLazy, pgetAlsKontextBOBeiAuftraegenLazy, pgetWirdAlsAntwortAnVerwendetBeiAlarmenLazy, pgetWirdBenachrichtigtBCCBeiAlarmLazy, pgetWirdBenachrichtigtBeiAlarmLazy, pgetWirdBenachrichtigtCCBeiAlarmLazy, removeAlsAntwortAnBeiAuftrag, removeAlsEmpfaengerBCCBeiAuftrag, removeAlsEmpfaengerBeiAuftrag, removeAlsEmpfaengerCCBeiAuftrag, removeAlsKontextBOBeiAuftrag, removeWirdAlsAntwortAnVerwendetBeiAlarm, removeWirdBenachrichtigtBCCBeiAlarm, removeWirdBenachrichtigtBeiAlarm, removeWirdBenachrichtigtCCBeiAlarm, setAlsAntwortAnBeiAuftraegen, setAlsEmpfaengerBCCBeiAuftraegen, setAlsEmpfaengerBeiAuftraegen, setAlsEmpfaengerCCBeiAuftraegen, setAlsKontextBOBeiAuftraegen, setWirdAlsAntwortAnVerwendetBeiAlarmen, setWirdBenachrichtigtBCCBeiAlarm, setWirdBenachrichtigtBeiAlarm, setWirdBenachrichtigtCCBeiAlarm

Methods inherited from class de.ipcon.db.core.BO

_set, $, $, $, $$, $$bo, $$o, $$r, $$ri, $$ri, acquireTxWriteLock, add, afterSaveOnClient, afterSaveOnServer, afterVerifyOnClient, aggregate, aggregate, aggregate, aggregate, badge, badge, beforeVerifyOnClient, beforeVerifyOnServer, bumpVersion, cacheLocally, cacheLocally, cacheLocallyAndThrowUnwrappedCause, cacheLocallyAndThrowUnwrappedCause, cacheLocallyAndThrowUnwrappedUncheckedCause, cacheLocallyAndThrowUnwrappedUncheckedCause, cancelRecalc, cancelRecalcViaLoadingTransaction, clone, commitTransaction, computeTransientPropertyIfAbsent, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, consumeAndAssureTransientPropertyExists, copyBLOBFrom, deepClone, deepClone, describe, describe, describe, describe, describe, describe, describe, describe, describe, describe, describeId, describeId, describeId, describeId, describeId, describeId, describeId, describeId, describeNE, describeNE, describeNE, describeNE, describeNE, destub, equalPayload, equalPayload, equalPayload, equalPayload, equals, equalsBO, equalsBO, equalsRegardingAttrs, exportBLOB, exReadString, exWriteString, forgetTransientBLOBHandle, frap, getAsBOInIssueReports, getAsBOInIssueReportsIterator, getAsString, getBackendBOLoaderWithPersistenceHandler, getBadge, getBadge, getBadge2, getBadge3, getBadge4, getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOBAsDataInput, getBLOBAsEncodedString, getBLOBAsEncodedString, getBLOBAsInputStream, getBLOBAsUTF8EncodedString, getBLOBCreatedBy, getBLOBCreatedOn, getBLOBDeletedBy, getBLOBDeletedOn, getBLOBInfo, getBLOBLastModifiedBy, getBLOBLastModifiedOn, getBOLoader, getBot, getBOVersion, getBytes, getCache, getCache, getCache, getCache, getCache, getCacheNT, getCacheNT, getCacheNT, getCacheNT, getCacheNT, getCacheProvider, getCacheProvider, getClazz, getCreatedBy, getCreatedModifiedText, getDefaultScriptImportsList, getDefaultScriptImportsList, getDefaultScriptImportsList, getDescribingBOWrapper, getDescribingBOWrapper, getEventProvider, getEventProvider, getId, getInvolvedInProcs, getInvolvedInProcsIterator, getLastModifiedBy, getLazyData, getLoadingTransaction, getNullIterator, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getPermissionHandler, getProcs, getProcsIterator, getRootLoaderSchema, getSchema, getSizeFast, getTransaction, getTransientProperty, getTransientProperty, getWrappedTransientProperty, hasActiveTransaction, hasBLOB, hasBLOBOnServerSide, hasBOAssignedTempId, hashCode, hasRelationObjects, hasRelationObjects, hasSessionAssignedTempId, hasTempId, hasTempIdForNewBOs, hasTransientProperty, hasTransientPropertyUnfiltered, includeAllowed, includeInTransaction, invalidateBLOBCache, isBOAssignedTempId, isCompoundChangeInProgress, isCurrentTransactionUnderAdminControl, isIgnoreModificationConstraints, isNew, isServerSideAndLoadedReadOnly, isSessionAssignedTempId, isStub, isTempId, isTempIdForNewInstance, isTemporary, isVisible, isWriteable, markCompoundChangeInProgress, markDelete, markUndelete, needLoadingTransaction, needsReload, needTransactionInclusion, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, nextTempId, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBusOfAdd, notifyMessageBusOfRemove, nullSafeCompareTo, nullSafeCompareTo, nullSafeContainsBO, nullSafeContainsBO, nullSafeEquals, nullSafeEqualsBO, nullSafeEqualsBO, ofStub, propertyMissing, propertyMissing, releaseCompoundChangeInProgress, releaseTxWriteLock, remove, removeBLOB, requireNonEmptyRelation, requireNonNullAttribute, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, setAsString, setBadge, setBadge, setBadge2, setBadge3, setBadge4, setBOLoaderNoCascade, setBOLoaderNoCascade, setBot, setId, setId, setIgnoreModificationConstraints, setLazyData, setTempId, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, slim, slim, storeBLOB, storeBLOB, storeBLOB, storeBLOB, storeBLOB, stub, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, undelete, wrapIfGroovy

Methods inherited from class de.ipcon.db.core.Synchable

getCrea, getLdel, getLmod, isDeleted, isLdel, setCrea, setLdel, setLdel, setLmod

Methods inherited from class de.ipcon.db.core.Transliterator

getInstanceSpecificLocale, getInstanceSpecificPaths, l10n, l10n, l10n, l10n, l10n, l10n, l10n

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.db.core.ParameterizedStrukturI

getIstAutomatikNN, istIstAutomatik

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

Methods inherited from interface de.ipcon.schema.BOI

bumpVersion, consumeAndAssureTransientPropertyExists, contains, equalsBO, equalsBO, filterDeleted, filterDeleted, filterDeleted, filterDeleted, filterDeletedAndReturnMap, filterDeletedAndReturnMap, getAttribute, getAttribute, getBLOB, getBLOB, getBOVersion, getClazz, getCrea, getEntity, getEntity, getRootLoaderSchema, getSchema, getTransientProperty, hasBLOB, hasTransientProperty, hasTransientPropertyUnfiltered, isDeleted, isNew, isSubEntityOf, isSubEntityOf, isTemporary, isVisible, setTransientProperty, toRelationMapRO

Methods inherited from interface de.ipcon.schema.Identifiable

collectIds, collectIds, getCommaSeparatedIdList, getId, toMap, toMap

Field Detail

FsExtension

public static final java.lang.String FsExtension

See Also:

Constant Field Values

ELEMENTNAME

public static final java.lang.String ELEMENTNAME

See Also:

Constant Field Values

PATTERN_PREFIX

public static final java.lang.String PATTERN_PREFIX

See Also:

Constant Field Values

PATTERN_POSTFIX

public static final java.lang.String PATTERN_POSTFIX

See Also:

Constant Field Values

pattern

public static final java.util.regex.Pattern pattern

PARAMNAME_USEFALLBACK

public static final java.lang.String PARAMNAME_USEFALLBACK

See Also:

Constant Field Values

PARAMNAME_OPTIONAL

public static final java.lang.String PARAMNAME_OPTIONAL

See Also:

Constant Field Values

Constructor Detail

Codebaustein

public Codebaustein()

Method Detail

initEnvironment

public static void initEnvironment(Transaction tx,
                                   UnresolvedReferencesResolver urr)

initEnvironment

public static void initEnvironment(Transaction tx,
                                   UnresolvedReferencesResolver urr,
                                   boolean authoritative)

getFsoForFile

public static FilesystemObject getFsoForFile(java.io.File baseDir,
                                             java.io.File f,
                                             java.lang.String name,
                                             boolean forceOneFile)

isReadOnly

public boolean isReadOnly(AttributeI attr)

Description copied from class: BO

Tells if the passed AttributeI is read-only in the context of this BO (for the UI and access via the schema). Please note that the schema-defined, not BO-related read-onlies are taken into account here as well, i.e. the method will return false if a virtual attribute is marked in the schema as

unless overridden in a subclass. Subclasses may override this method to add their own rules. If no rule exists in the subclass, the decision should always be delegated to super instead of just returning false to avoid inadvertenly breaking the rules defined in super-classes or the schema. You must never change the signature of this method, as subclasses override this and a lot of code would break or need to be adjusted.

Specified by:

isReadOnly in interface BOI

Overrides:

isReadOnly in class Struktur

Returns:

true if the given AttributeI is read-only in the context of this BO

isMandatory

public boolean isMandatory(AttributeI attr)

Description copied from class: BO

Tells if the passed AttributeI is mandatory in the context of this BO (for the UI and access via the schema). Please note that the schema-defined, not BO-related mandatories are taken into account here as well, i.e. the method will consistently return true if the attribute is marked in the schema as

unless overridden in a subclass. Subclasses may override this method to add their own rules. If no rule exists in the subclass, the decision should always be delegated to super instead of just returning false to avoid inadvertenly breaking the rules defined in super-classes or the schema. You must never change the signature of this method, as subclasses override this and a lot of code would break or need to be adjusted.

Specified by:

isMandatory in interface BOI

Overrides:

isMandatory in class Struktur

Returns:

true if the given AttributeI is mandatory in the context of this BO

verifyOnClient

public void verifyOnClient(BasicClientContextI ctx)

Specified by:

verifyOnClient in interface SaveVetoI

Overrides:

verifyOnClient in class Struktur

getParameter

public java.lang.String getParameter()

Description copied from interface: ParameterizedStrukturI

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 ParameterizedStrukturI.isLazy(), but without applying any further localization (l10n) or other complex preparations. This is useful when the raw, loaded string content is needed.

Specified by:

getParameter in interface ParameterizedStrukturI

Overrides:

getParameter in class de.ipcon.db.core.CodebausteinBase

Returns:

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

setParameter

public void setParameter(java.lang.String str)

Description copied from interface: ParameterizedStrukturI

Sets the value of the "Parameter" property.

Specified by:

setParameter in interface ParameterizedStrukturI

Overrides:

setParameter in class de.ipcon.db.core.CodebausteinBase

Parameters:

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

getRawParameter

public java.lang.String getRawParameter()

Description copied from interface: ParameterizedStrukturI

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.

Specified by:

getRawParameter in interface ParameterizedStrukturI

Returns:

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

getCookedParameter

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

Description copied from interface: ParameterizedStrukturI

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.

Specified by:

getCookedParameter in interface ParameterizedStrukturI

Overrides:

getCookedParameter in class Struktur

Parameters:

cbs - 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.

isLazy

public boolean isLazy()

Description copied from interface: ParameterizedStrukturI

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.

Specified by:

isLazy in interface ParameterizedStrukturI

Overrides:

isLazy in class Struktur

Returns:

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

unlazy

public void unlazy()

Description copied from interface: ParameterizedStrukturI

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

Specified by:

unlazy in interface ParameterizedStrukturI

Overrides:

unlazy in class Struktur

getIncludeElementText

public java.lang.String getIncludeElementText()

Generates a include command displayed in the View 'Sonstiges' of the Codebaustein. The generated command can be used in another code element to include and use this Codebaustein.

Specified by:

getIncludeElementText in class de.ipcon.db.core.CodebausteinBase

Returns:

The command in XML Format to include this Codebaustein

getBenutztInStrukturen

public java.util.Map<java.lang.Long,Struktur> getBenutztInStrukturen()

Specified by:

getBenutztInStrukturen in class de.ipcon.db.core.CodebausteinBase

getCookedParameter

public java.lang.String getCookedParameter()

replaceArguments

public java.lang.String replaceArguments(java.lang.String withPlaceholders,
                                         java.util.List<java.lang.String> listIncs,
                                         java.util.Map<java.lang.String,java.lang.String> mapArgValues)

Replaces the CBA placeholders with their appropriate value given via _mapArgValues.

Parameters:

withPlaceholders - the String in which placeholders should be replaced.

listIncs - "includes path" for error message output.

mapArgValues - a map with CBA names as keys and their replacement values as values.

Returns:

the given String with all placeholders replaced by their approptiate value.

getRelationsForDateiSystemSyncCache

public java.util.Map getRelationsForDateiSystemSyncCache()

Overrides:

getRelationsForDateiSystemSyncCache in class Struktur

exportToImpl

public void exportToImpl(FilesystemObject fso,
                         EntityI ent,
                         electric.xml.Element root)

Overrides:

exportToImpl in class Struktur

importFromXML

public void importFromXML(EntityI ent,
                          electric.xml.Element root,
                          java.util.Map<java.lang.String,Benannt> mapElterCache,
                          UnresolvedReferencesResolver urr,
                          boolean asAutomatik,
                          boolean keepValueIfXMLNotFound,
                          boolean allowAutomatik)

Overrides:

importFromXML in class Struktur

createCopy

public BO createCopy()

Description copied from class: BO

Creates a copy of this BO. If a Transaction is given, the copy will first be included in this TX to record all the copy operations. Uses copyFrom() to copy the values from this to the new instance. CAUTION: *ALL* n-1-reachable objects will be copied as well! Attention: Does not honour the "omitOnCopy" flag from the schema!

Overrides:

createCopy in class Struktur

Returns:

a copy of this BO

See Also:

de.ipcon.db.core.BO#copyFrom(), de.ipcon.db.core.Transaction#includeCopy()

createCopy

public BO createCopy(Transaction tx)

Overrides:

createCopy in class Struktur

toString

public java.lang.String toString()

Overrides:

toString in class BO