de.ipcon.schema

Interface DescribableI

All Known Subinterfaces:

BOI, FilterableStrukturI, InstrumentingBO, LimitableToMyTISMAdresstypI, NotifiableI, NotificationAttachmentI, NotificationReceiverCollectionI, NotificationReceiverI, PolymorphicFilterableStrukturI, XMLExportableI

All Known Implementing Classes:

AenderungsTyp, de.ipcon.db.core.AenderungsTypBase, Alarm, AlarmAusloesung, de.ipcon.db.core.AlarmAusloesungBase, AlarmAusloesungFuerBO, de.ipcon.db.core.AlarmAusloesungFuerBOBase, AlarmAusloesungFuerUnsyncedBO, de.ipcon.db.core.AlarmAusloesungFuerUnsyncedBOBase, de.ipcon.db.core.AlarmBase, AlarmBenachrichtigungsauftrag, de.ipcon.db.core.AlarmBenachrichtigungsauftragBase, Alias, de.ipcon.db.core.AliasBase, Anmeldung, de.ipcon.db.core.AnmeldungBase, ArrayTestBO, de.ipcon.db.core.ArrayTestBOBase, ArrayZeilenDelegate, de.ipcon.db.core.ArrayZeilenDelegateBase, ArrayZeilenWrapper, de.ipcon.db.core.ArrayZeilenWrapperBase, AusloeseKriterium, de.ipcon.db.core.AusloeseKriteriumBase, BedingterAlarm, de.ipcon.db.core.BedingterAlarmBase, Benachrichtigungsversendung, de.ipcon.db.core.BenachrichtigungsversendungBase, Benannt, de.ipcon.db.core.BenanntBase, Benutzer, de.ipcon.db.core.BenutzerBase, BenutzerGroupAspects, BenutzerMFAAspects, BF, de.ipcon.db.core.BFBase, Bild, de.ipcon.db.core.BildBase, BildPosten, de.ipcon.db.core.BildPostenBase, BN, de.ipcon.db.core.BNBase, BO, BOAssociatedAlarm, de.ipcon.db.core.BOAssociatedAlarmBase, BOBasierterTermin, de.ipcon.db.core.BOBasierterTerminBase, BOMaske, de.ipcon.db.core.BOMaskeBase, BOT, de.ipcon.db.core.BOTBase, BP, de.ipcon.db.core.BPBase, BS, de.ipcon.db.core.BSBase, BT, de.ipcon.db.core.BTBase, BU, de.ipcon.db.core.BUBase, BX, de.ipcon.db.core.BXBase, de.ipcon.db.core.ClassRef, Codebaustein, CodebausteinArgument, de.ipcon.db.core.CodebausteinArgumentBase, de.ipcon.db.core.CodebausteinBase, CoreBO, de.ipcon.db.core.CoreBOBase, CustomBTProperty, de.ipcon.db.core.CustomBTPropertyBase, DateiSystemSync, de.ipcon.db.core.DateiSystemSyncBase, DateiSystemSyncEintrag, de.ipcon.db.core.DateiSystemSyncEintragBase, Druckziel, de.ipcon.db.core.DruckzielBase, DynamischerOrdner, de.ipcon.db.core.DynamischerOrdnerBase, EinfacherTermin, de.ipcon.db.core.EinfacherTerminBase, EinstellungenVariable, de.ipcon.db.core.EinstellungenVariableBase, EinstellungenVariablenWert, de.ipcon.db.core.EinstellungenVariablenWertBase, EinstellungenVarWertBenutzer, de.ipcon.db.core.EinstellungenVarWertBenutzerBase, EinstellungenVarWertGruppe, de.ipcon.db.core.EinstellungenVarWertGruppeBase, EmailRoutingRegel, de.ipcon.db.core.EmailRoutingRegelBase, Folder, de.ipcon.db.core.FolderBase, Formular, de.ipcon.db.core.FormularBase, GrooqlBOMaske, de.ipcon.db.core.GrooqlBOMaskeBase, Gruppe, de.ipcon.db.core.GruppeBase, Hinweis, de.ipcon.db.core.HinweisBase, InternalNotificationRetryWV, de.ipcon.db.core.InternalNotificationRetryWVBase, IssueReport, de.ipcon.db.core.IssueReportBase, IssueUrgency, de.ipcon.db.core.IssueUrgencyBase, JavaImp, de.ipcon.db.core.JavaImpBase, L10nBundle, de.ipcon.db.core.L10nBundleBase, L10nEntry, de.ipcon.db.core.L10nEntryBase, L10nLocale, de.ipcon.db.core.L10nLocaleBase, L10nResource, de.ipcon.db.core.L10nResourceBase, Lesezeichen, de.ipcon.db.core.LesezeichenBase, de.ipcon.db.core.LogBO, de.ipcon.db.core.MultiFaktorSchluessel, MyTISMAdresse, de.ipcon.db.core.MyTISMAdresseBase, MyTISMAdresseEmail, de.ipcon.db.core.MyTISMAdresseEmailBase, MyTISMAdresseSolstice, de.ipcon.db.core.MyTISMAdresseSolsticeBase, MyTISMAdresstyp, de.ipcon.db.core.MyTISMAdresstypBase, de.ipcon.db.core.MyTISMAdresstypBeschraenkung, MyTISMAdresstypBeschraenkungFuerAuftrag, de.ipcon.db.core.MyTISMAdresstypBeschraenkungFuerAuftragBase, MyTISMAnhangBOEintrag, de.ipcon.db.core.MyTISMAnhangBOEintragBase, MyTISMBenachrichtigung, de.ipcon.db.core.MyTISMBenachrichtigungBase, MyTISMBenachrichtigungsAuftrag, de.ipcon.db.core.MyTISMBenachrichtigungsAuftragBase, MyTISMBenachrichtigungstyp, de.ipcon.db.core.MyTISMBenachrichtigungstypBase, MyTISMBenachrichtigungsVorlage, de.ipcon.db.core.MyTISMBenachrichtigungsVorlageBase, de.ipcon.db.core.MyTISMBenAuftragBOEintrag, MyTISMBenAuftragMitVorlage, de.ipcon.db.core.MyTISMBenAuftragMitVorlageBase, MyTISMBenAuftragOhneVorlage, de.ipcon.db.core.MyTISMBenAuftragOhneVorlageBase, MyTISMKontextBOEintrag, de.ipcon.db.core.MyTISMKontextBOEintragBase, NotfallSchluessel, de.ipcon.db.core.NotfallSchluesselBase, Ordner, de.ipcon.db.core.OrdnerBase, RechteZuweisung, de.ipcon.db.core.RechteZuweisungBase, RechteZuweisungDigest, de.ipcon.db.core.RechteZuweisungDigestBase, Report, de.ipcon.db.core.ReportBase, Schablone, de.ipcon.db.core.SchabloneBase, Struktur, de.ipcon.db.core.StrukturBase, Strukturlesezugriffe, de.ipcon.db.core.StrukturlesezugriffeBase, TOTPSchluessel, de.ipcon.db.core.TOTPSchluesselBase, WebAuthnCredential, de.ipcon.db.core.WebAuthnCredentialBase, Wiedervorlage, de.ipcon.db.core.WiedervorlageBase, Zeitzone, de.ipcon.db.core.ZeitzoneBase

public interface DescribableI

This interface is just for being able to call describe on a BO inside MultipleChoiceFilterGUI.nrx - mainly compile problems led to this interface.

See Also:

BO

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<java.lang.String>	collectDescribe(java.util.Collection<? extends DescribableI> col, java.lang.String cboFormat, boolean removeDuplicates) Iterates over a collection of DescribableI-s (i.e.
static java.util.Collection<java.lang.String>	collectDescribe(java.util.Collection<DescribableI> col, java.lang.String cboFormat) This method iterates over a collection of DescribableI-s (i.e.
java.lang.String	conciseDesc() Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status.
java.lang.String	conciseDesc(boolean showRuntimeInfo) Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status.
java.lang.String	conciseDesc(boolean showRuntimeInfo, boolean showCreaLmod) Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status.
java.lang.String	conciseDesc(boolean showRuntimeInfo, boolean showCreaLmod, boolean useClientSideId) Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status.
static java.lang.String	conciseDesc(DescribableI d) Null-safe static version of conciseDesc.
static java.lang.String	conciseDesc(DescribableI d, boolean showRuntimeInfo)
static java.lang.String	conciseDesc(DescribableI d, boolean showRuntimeInfo, boolean showCreaLmod)
static java.lang.String	conciseDesc(DescribableI d, boolean showRuntimeInfo, boolean showCreaLmod, boolean useClientSideId)
java.lang.String	describe() Returns a nice description of this DescribableI.
static java.lang.String	describe(DescribableI d) Null-safe static version of describe.
static java.lang.String	describe(DescribableI d, java.lang.String pattern)
java.lang.String	describe(java.lang.String pattern) Returns a nice description of this DescribableI.
static java.lang.String	describeAndConciseDesc(DescribableI d) Null-safe static method for undecided folks, which want both: a nice description of the given DescribableI as well as a concise description of it in braces after that.
static java.lang.String	describeAndConciseDesc(DescribableI d, java.lang.String pattern)
static java.lang.String	describeAndConciseDesc(DescribableI d, java.lang.String pattern, boolean showRuntimeInfo)
static java.lang.String	describeAndConciseDesc(DescribableI d, java.lang.String pattern, boolean showRuntimeInfo, boolean showCreaLmod)
static java.lang.String	describeAndConciseDesc(DescribableI d, java.lang.String pattern, boolean showRuntimeInfo, boolean showCreaLmod, boolean useClientSideId)
default java.lang.String	describeNE() Returns a nice description of this DescribableI.
default java.lang.String	describeNE(java.lang.String pattern) Returns a nice description of this DescribableI.
static java.lang.String	join(java.util.Collection col, java.lang.String separator, boolean removeEmptyStrings, boolean removeDuplicates, java.lang.String cboFormat) Returns a String containing a (default by comma) separated list of the String-representations of objects which are passed by the given Collection or an empty String if the Collection is null or empty.
static java.lang.String	join(java.util.Collection col, java.lang.String separator, boolean removeEmptyStrings, boolean removeDuplicates, java.lang.String cboFormat, java.lang.String surround)
static java.lang.String	join(java.util.Collection col, java.lang.String separator, boolean removeEmptyStrings, boolean removeDuplicates, java.lang.String cboFormat, java.lang.String surround, java.lang.String prefix)
static java.lang.String	notEmptyDescription(java.lang.String s, java.lang.Object o) If the passed String is not empty, it is returned as is.

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

join

static java.lang.String join(java.util.Collection col,
                             java.lang.String separator,
                             boolean removeEmptyStrings,
                             boolean removeDuplicates,
                             java.lang.String cboFormat)

Returns a String containing a (default by comma) separated list of the String-representations of objects which are passed by the given Collection or an empty String if the Collection is null or empty.

Parameters:

col - Collection of objects, which shall be output in their String-representation.

separator - String sequence which should be used for separating the values. Default is #DEFAULT_SEPARATOR.

removeEmptyStrings - If true, the resulting String will not contain empty or null fields. Default is false.

removeDuplicates - If true, duplicate fields will be filtered out; the first Object returned by the Collections iterator will be retained while all following Objects which return true for a call to equals() on any previously found Object will be ignored. Default is false.

cboFormat - If defined, we try to cast the objects within the collection to DescribableI and use the given cboFormat to describe the object. Default is null.

surround - If defined each element of the collection is surrounded by this String. Default is the empty String.

prefix - If not null this String will be prepended to the returned String. Default is null.

Returns:

String with the concatenated separator-separated String representations.

See Also:

collectDescribe, collectIds

join

static java.lang.String join(java.util.Collection col,
                             java.lang.String separator,
                             boolean removeEmptyStrings,
                             boolean removeDuplicates,
                             java.lang.String cboFormat,
                             java.lang.String surround)

join

static java.lang.String join(java.util.Collection col,
                             java.lang.String separator,
                             boolean removeEmptyStrings,
                             boolean removeDuplicates,
                             java.lang.String cboFormat,
                             java.lang.String surround,
                             java.lang.String prefix)

collectDescribe

static java.util.Collection<java.lang.String> collectDescribe(java.util.Collection<DescribableI> col,
                                                              java.lang.String cboFormat)

This method iterates over a collection of DescribableI-s (i.e. BOs) and returns a new collection of type String with the result of describe, but containing each text only once. The returned collection is a Set.

Parameters:

col - The collection of DescribableI objects to describe.

cboFormat - The format of the description.

Returns:

The collective descriptions for these BOs, non-null.

collectDescribe

static java.util.Collection<java.lang.String> collectDescribe(java.util.Collection<? extends DescribableI> col,
                                                              java.lang.String cboFormat,
                                                              boolean removeDuplicates)

Iterates over a collection of DescribableI-s (i.e. BOs) and returns a new collection of type String with the result of describe. The returned collection is of the same subtype as the provided collection (List vs Set), unless the parameter removeDuplicates is used. Then a Set will be returned.

Parameters:

col - The collection of DescribableI objects to describe.

cboFormat - The format of the description.

removeDuplicates - If true, then the result will contain each text only once. If false, duplicates are possible.

Returns:

The collective descriptions for these BOs, non-null.

notEmptyDescription

static java.lang.String notEmptyDescription(java.lang.String s,
                                            java.lang.Object o)

If the passed String is not empty, it is returned as is. If the passed String is empty, an alternative description enclosed in « and » is generated: If the passed Object is a DescribableI, the conciseDesc without runtime-infos is returned. Otherwise a String.valueOf() is created for the passed object. If the String.valueOf() still returned an empty String, the identityHashCode() is used as last resort.

describe

static java.lang.String describe(DescribableI d)

Null-safe static version of describe. Returns a nice description of the given DescribableI. Format is according to the given pattern, or as specified in the schema, if pattern is null.

describe

static java.lang.String describe(DescribableI d,
                                 java.lang.String pattern)

conciseDesc

static java.lang.String conciseDesc(DescribableI d)

Null-safe static version of conciseDesc. Returns the 'null' String for a null-Describable and calls conciseDesc on the DescribableI otherwise.

conciseDesc

static java.lang.String conciseDesc(DescribableI d,
                                    boolean showRuntimeInfo)

conciseDesc

static java.lang.String conciseDesc(DescribableI d,
                                    boolean showRuntimeInfo,
                                    boolean showCreaLmod)

conciseDesc

static java.lang.String conciseDesc(DescribableI d,
                                    boolean showRuntimeInfo,
                                    boolean showCreaLmod,
                                    boolean useClientSideId)

describeAndConciseDesc

static java.lang.String describeAndConciseDesc(DescribableI d)

Null-safe static method for undecided folks, which want both: a nice description of the given DescribableI as well as a concise description of it in braces after that. Returns the 'null' String for a null-DescribableI.

describeAndConciseDesc

static java.lang.String describeAndConciseDesc(DescribableI d,
                                               java.lang.String pattern)

describeAndConciseDesc

static java.lang.String describeAndConciseDesc(DescribableI d,
                                               java.lang.String pattern,
                                               boolean showRuntimeInfo)

describeAndConciseDesc

static java.lang.String describeAndConciseDesc(DescribableI d,
                                               java.lang.String pattern,
                                               boolean showRuntimeInfo,
                                               boolean showCreaLmod)

describeAndConciseDesc

static java.lang.String describeAndConciseDesc(DescribableI d,
                                               java.lang.String pattern,
                                               boolean showRuntimeInfo,
                                               boolean showCreaLmod,
                                               boolean useClientSideId)

describe

java.lang.String describe()

Returns a nice description of this DescribableI. Format is specified in the schema.

describeNE

default java.lang.String describeNE()

Returns a nice description of this DescribableI. Format is specified in the schema. If the description is not empty, it is returned as is. If the description is empty, an alternative description enclosed in « and » is generated: The conciseDesc without runtime-infos is returned.

describe

java.lang.String describe(java.lang.String pattern)

Returns a nice description of this DescribableI. Format is according to the given pattern or as specified in the schema if pattern is null.

describeNE

default java.lang.String describeNE(java.lang.String pattern)

Returns a nice description of this DescribableI. Format is according to the given pattern or as specified in the schema if pattern is null. If the description is not empty, it is returned as is. If the description is empty, an alternative description enclosed in « and » is generated: The conciseDesc without runtime-infos is returned.

conciseDesc

java.lang.String conciseDesc(boolean showRuntimeInfo,
                             boolean showCreaLmod,
                             boolean useClientSideId)

Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status. Please *do* keep this description *concise* and only add stuff it is really important and useful (and I can't currently think of anything else which fits these criteria :-)

Parameters:

showRuntimeInfo - if true will also include if DescribableI is a stub or if the DescribableI needs to be reloaded to get an instance with the actual subclass and will include the hashCode.

showCreaLmod - if false will not show Crea and Lmod values; if true these values will be appended to the description.

useClientSideId - if true the Id that is known on client-side is used; on server-side we might already have an unsaved positive Id, but for the description e.g. in a server-side error message it might be less confusing to use the Id that is known on the client; e.g. when used inside a SaveVetoException it might otherwise be very confusing to report an Id that is discarded again and never used in the database ever.

Returns:

a concise description for this DescribableI.

conciseDesc

java.lang.String conciseDesc(boolean showRuntimeInfo,
                             boolean showCreaLmod)

Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status. Please *do* keep this description *concise* and only add stuff it is really important and useful (and I can't currently think of anything else which fits these criteria :-)

Parameters:

showRuntimeInfo - if true will also include if DescribableI is a stub or if the DescribableI needs to be reloaded to get an instance with the actual subclass and will include the hashCode.

showCreaLmod - if false will not show Crea and Lmod values; if true these values will be appended to the description.

Returns:

a concise description for this DescribableI.

conciseDesc

java.lang.String conciseDesc(boolean showRuntimeInfo)

Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status. Please *do* keep this description *concise* and only add stuff it is really important and useful (and I can't currently think of anything else which fits these criteria :-)

Parameters:

showRuntimeInfo - if true will also include if DescribableI is a stub or if the DescribableI needs to be reloaded to get an instance with the actual subclass and will include the hashCode.

Returns:

a concise description for this DescribableI.

conciseDesc

java.lang.String conciseDesc()

Returns a concise description for this DescribableI consisting of classname, Id and Ldel/New status. Additionally it is shown if the BO is a stub or if the DescribableI needs to be reloaded to get an instance with the actual subclass. Includes the hashCode as well. Please *do* keep this description *concise* and only add stuff it is really important and useful (and I can't currently think of anything else which fits these criteria :-)

Returns:

a concise description for this DescribableI.