de.ipcon.schema

Interface Identifiable

All Known Subinterfaces:

BOI, FilterableStrukturI, InstrumentingBO, LimitableToMyTISMAdresstypI, NotificationAttachmentI, PolymorphicFilterableStrukturI, XMLExportableI

All Known Implementing Classes:

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

public interface Identifiable

We need to use the Id-aspect of de.ipcon.db.core.BO early on, so we use this interface.

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<java.lang.Long>	collectIds(java.util.Collection<? extends Identifiable> col) Iterates over a collection of Identifiable and returns a new Set of type Long with the result of getId.
static java.util.Collection<java.lang.Long>	collectIds(java.util.Collection<? extends Identifiable> col, boolean removeDuplicates) Iterates over a collection of Identifiable and returns a new collection of type Long with the result of getId.
static java.lang.String	getCommaSeparatedIdList(java.util.Collection col) Returns a String containing a comma separated list of the Ids of the passed Identifiable-objects.
java.lang.Long	getId() Gets the internal Id of this Identifiable.
static <I extends Identifiable> java.util.Map<java.lang.Long,I>	toMap(java.util.Collection<I> c)
static <I extends Identifiable> java.util.Map<java.lang.Long,I>	toMap(java.util.Collection<I> c, java.util.Map<java.lang.Long,I> map) Creates a map from the given Collection of Identifiables with the Id as key and the Identifiable as value.

Method Detail

getCommaSeparatedIdList

static java.lang.String getCommaSeparatedIdList(java.util.Collection col)

Returns a String containing a comma separated list of the Ids of the passed Identifiable-objects. This is especially useful for queries with "in list" statements. If anything else than an Identifiable is part of the passed collection, then its String-value is used for the list. Please prefer "Id in $1" queries and collectIds(java.util.Collection<? extends de.ipcon.schema.Identifiable>) in the future, because it improves performance for large Id lists.

Parameters:

col - Collection of objects, which shall be output with their Id if they are instances of Identifiable or in their String-representation otherwise.

Returns:

String with the concatenated comma separated Ids or String representations.

toMap

static <I extends Identifiable> java.util.Map<java.lang.Long,I> toMap(java.util.Collection<I> c)

collectIds

static java.util.Collection<java.lang.Long> collectIds(java.util.Collection<? extends Identifiable> col)

Iterates over a collection of Identifiable and returns a new Set of type Long with the result of getId. Difference between this method and DescribableI.collectDescribe(col, 'Id') is the element type of the returned collection.

Parameters:

col - The collection of Identifiable objects to gather Ids from.

Returns:

A collection of Longs - the Ids of the Identifiables, non-null.

collectIds

static java.util.Collection<java.lang.Long> collectIds(java.util.Collection<? extends Identifiable> col,
                                                       boolean removeDuplicates)

Iterates over a collection of Identifiable and returns a new collection of type Long with the result of getId. 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. Difference between this method and DescribableI.collectDescribe(col, 'Id') is the element type of the returned collection.

Parameters:

col - The collection of Identifiable objects to gather Ids from.

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

Returns:

A collection of Longs - the Ids of the Identifiables, non-null.

toMap

static <I extends Identifiable> java.util.Map<java.lang.Long,I> toMap(java.util.Collection<I> c,
                                                                      java.util.Map<java.lang.Long,I> map)

Creates a map from the given Collection of Identifiables with the Id as key and the Identifiable as value.

getId

java.lang.Long getId()

Gets the internal Id of this Identifiable. The returned value can either be positive or negative in case of not yet persisted BOs. Can be null if the Identifiable is not completely initialized yet.

Returns:

a Long with the unique Id of this Identifiable, nullable.