BOI (MyTISM API Documentation)

All Superinterfaces:

DescribableI, Identifiable, SchemaProviderI

All Known Subinterfaces:

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 BOI
extends Identifiable, DescribableI, SchemaProviderI
```
We don't know about de.ipcon.db.core.BO yet so we use this interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATT_Badge`
`static java.lang.String`	`ATT_Badge2`
`static java.lang.String`	`ATT_Badge3`
`static java.lang.String`	`ATT_Badge4`
`static java.lang.String`	`ATT_BLOBCreatedBy`
`static java.lang.String`	`ATT_BLOBCreatedOn`
`static java.lang.String`	`ATT_BLOBDeletedBy`
`static java.lang.String`	`ATT_BLOBDeletedOn`
`static java.lang.String`	`ATT_BLOBLastModifiedBy`
`static java.lang.String`	`ATT_BLOBLastModifiedOn`
`static java.lang.String`	`ATT_Bot`
`static java.lang.String`	`ATT_Crea`
`static java.lang.String`	`ATT_CreatedBy`
`static java.lang.String`	`ATT_CreatedModifiedText`
`static java.lang.String`	`ATT_Id`
`static java.lang.String`	`ATT_InvolvedInProcs`
`static java.lang.String`	`ATT_LastModifiedBy`
`static java.lang.String`	`ATT_Ldel`
`static java.lang.String`	`ATT_Lmod`
`static java.lang.String`	`ATT_Procs`
`static BOI[]`	`EMPTY_ARRAY`
`static java.lang.String`	`ENT_BO`

Fields inherited from interface de.ipcon.schema.DescribableI
$0

Fields inherited from interface de.ipcon.schema.SchemaProviderI
$0

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`bumpVersion()` increase version value to signal a modification
`boolean`	`cancelCheckConstraints()` should we check constraints (read only etc) before calling set/add/remove?
`void`	`consumeAndAssureTransientPropertyExists(java.lang.String name, java.util.function.Consumer<java.lang.Object[]> operation, java.lang.Object[] args)` Performs the given Consumer operation on the passed args.
`static boolean`	`contains(java.util.Collection<?> haystack, BOI needle)`
`boolean`	`equalsBO(BOI bo)` `BO.nullSafeEqualsBO(BOI, BOI)` is called with this BOI as first parameter and the passed BOI as second one.
`boolean`	`equalsBO(BOI bo, boolean idComparisonOnly)` `BO.nullSafeEqualsBO(BOI, BOI)` is called with this BOI as first parameter and the passed BOI as second one.
`default AttributeI`	`getAttribute(java.lang.String attPath)` Returns the AttributeI at the end of the given attribute path within this BOI's entity.
`default AttributeI`	`getAttribute(java.lang.String attPath, boolean throwFlag)`
`long`	`getBLOB(java.io.OutputStream target)`
`long`	`getBLOB(java.io.OutputStream target, boolean closeOS)`
`int`	`getBOVersion()` A value that is incremented each time the BO is modified.
`java.lang.Class<? extends BOI>`	`getClazz()`
`java.util.Date`	`getCrea()`
`default EntityI`	`getEntity()` Returns the associated EntityI of this BOI within its current SchemaI.
`default EntityI`	`getEntity(boolean throwFlag)` Returns the associated EntityI of this BOI within the current SchemaI.
`SchemaI`	`getRootLoaderSchema()`
`SchemaI`	`getSchema()`
`java.lang.Object`	`getTransientProperty(java.lang.String name)` Returns the value that was saved using the given transient property name.
`boolean`	`hasBLOB()`
`boolean`	`hasTransientProperty(java.lang.String name)` Returns true, if a transient property with the given name currently exists.
`boolean`	`hasTransientPropertyUnfiltered(java.lang.String name)` Returns true, if a transient property with the given name exists or existed, i.e. not filtering out already expired versions.
`boolean`	`isDeleted()` Checks whether this BO has been marked as (soft) deleted and should therefore no longer be taken into account.
`boolean`	`isMandatory(AttributeI attr)`
`boolean`	`isNew()` Checks whether this BO has been created recently.
`boolean`	`isReadOnly(AttributeI attr)`
`default boolean`	`isSubEntityOf(java.lang.String possibleSuperEntityName)` Checks if this BOI's EntityI is a sub-entity of the specified super entity or that entity itself.
`default boolean`	`isSubEntityOf(StructuredEntityI possibleSuperEntity)` Checks if this BOI's EntityI is a sub-entity of the specified super entity or that entity itself.
`boolean`	`isTemporary()`
`boolean`	`isVisible(AttributeI attr)`
`java.lang.Object`	`setTransientProperty(java.lang.String name, java.lang.Object value)` Saves a transient value with the provided name for this BO.
`static java.util.Map<java.lang.Long,BOI>`	`toRelationMapRO(java.util.Map<java.lang.Long,BOI> m)` Returns an unmodifiable `Map` with the same entries as the passed Map, suitable for usage as return value of a getter for a read-only virtual relation.

Methods inherited from interface de.ipcon.schema.Identifiable
collectIds, collectIds, getCommaSeparatedIdList, getId, toMap, toMap

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
  - ENT_BO
```
static final java.lang.String ENT_BO
```
    See Also:
    
    Constant Field Values
  - ATT_Id
```
static final java.lang.String ATT_Id
```
    See Also:
    
    Constant Field Values
  - ATT_Crea
```
static final java.lang.String ATT_Crea
```
    See Also:
    
    Constant Field Values
  - ATT_Lmod
```
static final java.lang.String ATT_Lmod
```
    See Also:
    
    Constant Field Values
  - ATT_Ldel
```
static final java.lang.String ATT_Ldel
```
    See Also:
    
    Constant Field Values
  - ATT_Bot
```
static final java.lang.String ATT_Bot
```
    See Also:
    
    Constant Field Values
  - ATT_Procs
```
static final java.lang.String ATT_Procs
```
    See Also:
    
    Constant Field Values
  - ATT_InvolvedInProcs
```
static final java.lang.String ATT_InvolvedInProcs
```
    See Also:
    
    Constant Field Values
  - ATT_Badge
```
static final java.lang.String ATT_Badge
```
    See Also:
    
    Constant Field Values
  - ATT_Badge2
```
static final java.lang.String ATT_Badge2
```
    See Also:
    
    Constant Field Values
  - ATT_Badge3
```
static final java.lang.String ATT_Badge3
```
    See Also:
    
    Constant Field Values
  - ATT_Badge4
```
static final java.lang.String ATT_Badge4
```
    See Also:
    
    Constant Field Values
  - ATT_CreatedBy
```
static final java.lang.String ATT_CreatedBy
```
    See Also:
    
    Constant Field Values
  - ATT_LastModifiedBy
```
static final java.lang.String ATT_LastModifiedBy
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBCreatedBy
```
static final java.lang.String ATT_BLOBCreatedBy
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBCreatedOn
```
static final java.lang.String ATT_BLOBCreatedOn
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBDeletedBy
```
static final java.lang.String ATT_BLOBDeletedBy
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBDeletedOn
```
static final java.lang.String ATT_BLOBDeletedOn
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBLastModifiedBy
```
static final java.lang.String ATT_BLOBLastModifiedBy
```
    See Also:
    
    Constant Field Values
  - ATT_BLOBLastModifiedOn
```
static final java.lang.String ATT_BLOBLastModifiedOn
```
    See Also:
    
    Constant Field Values
  - ATT_CreatedModifiedText
```
static final java.lang.String ATT_CreatedModifiedText
```
    See Also:
    
    Constant Field Values
  - EMPTY_ARRAY
```
static final BOI[] EMPTY_ARRAY
```
- Method Detail
  - equalsBO
```
boolean equalsBO(BOI bo)
```
    BO.nullSafeEqualsBO(BOI, BOI) is called with this BOI as first parameter and the passed BOI as second one.
  - equalsBO
```
boolean equalsBO(BOI bo,
                 boolean idComparisonOnly)
```
    BO.nullSafeEqualsBO(BOI, BOI) is called with this BOI as first parameter and the passed BOI as second one.
  - getClazz
```
java.lang.Class<? extends BOI> getClazz()
```
    Returns:
    
    the Java Class Object for this BO
  - getCrea
```
java.util.Date getCrea()
```
  - getRootLoaderSchema
```
SchemaI getRootLoaderSchema()
```
  - getSchema
```
SchemaI getSchema()
```
    Specified by:
    
    getSchema in interface SchemaProviderI
    
    Returns:
    
    the SchemaI instance used by this object or null, if no Schema is available
  - getEntity
```
default EntityI getEntity()
```
    Returns the associated EntityI of this BOI within its current SchemaI. Returns null if no Schema is available, which may occur if no BOLoaderI is set.
    
    Returns:
    
    The EntityI associated with this BOI in its current SchemaI, or null if no Schema is available.
  - getEntity
```
default EntityI getEntity(boolean throwFlag)
```
    Returns the associated EntityI of this BOI within the current SchemaI. Throws IllegalStateException or returns null if no Schema is available (probably no BOLoaderI set), depending on the passed throw parameter.
    
    Parameters:
    
    throwFlag - If true, throws IllegalStateException if no Schema is available; if false, returns null.
    
    Returns:
    
    The EntityI associated with this BOI in its current SchemaI, or null if no Schema is available and throwFlag is false.
    
    Throws:
    
    java.lang.IllegalStateException - if no Schema is available and throwFlag is true
  - getAttribute
```
default AttributeI getAttribute(java.lang.String attPath)
```
    Returns the AttributeI at the end of the given attribute path within this BOI's entity. Returns null if no BOLoaderI/SchemaI is available or if an attribute along the attribute path is unknown.
    
    Parameters:
    
    attPath - The attribute path to retrieve the attribute from.
    
    Returns:
    
    The AttributeI at the end of the attribute path, or null if no BOLoaderI/SchemaI is available or if an attribute along the path is unknown.
  - getAttribute
```
default AttributeI getAttribute(java.lang.String attPath,
                                boolean throwFlag)
```
    Returns:
    
    the attribute at the end of the given attPath within the current BOI's entity. or null if throwFlag is false and no BOLoaderI/SchemaI is available or an attribute along the attPath is unknown.
    
    Throws:
    
    java.lang.IllegalStateException - if throwFlag is true and schema is missing.
    
    AttributeResolveException - if throwFlag is true and an attribute along the attPath is unknown.
  - isSubEntityOf
```
default boolean isSubEntityOf(java.lang.String possibleSuperEntityName)
```
    Checks if this BOI's EntityI is a sub-entity of the specified super entity or that entity itself.
    
    Parameters:
    
    possibleSuperEntityName - The name of the possible super entity to check against.
    
    Returns:
    
    True if this this BOI's EntityI is a sub-entity of the specified super entity or that entity itself, false otherwise.
  - isSubEntityOf
```
default boolean isSubEntityOf(StructuredEntityI possibleSuperEntity)
```
    Checks if this BOI's EntityI is a sub-entity of the specified super entity or that entity itself.
    
    Parameters:
    
    possibleSuperEntity - The possible super entity to check against.
    
    Returns:
    
    True if this this BOI's EntityI is a sub-entity of the specified super entity or that entity itself, false otherwise.
  - isNew
```
boolean isNew()
```
    Checks whether this BO has been created recently. Recently in this case means: Its Id is null or negative or it is included in the transaction which created -and possibly already saved- this BO.
    
    Returns:
    
    true, if this BO is not yet persisted or has been created within the transaction it is included in. false otherwise, i.e. it was loaded from persistent storage.
  - isTemporary
```
boolean isTemporary()
```
    Returns:
    
    true if this BO is only temporary, was and never will be persisted, false otherwise.
  - isDeleted
```
boolean isDeleted()
```
    Checks whether this BO has been marked as (soft) deleted and should therefore no longer be taken into account.
    
    Returns:
    
    true if this BO has its deleted flag set to true, false otherwise.
  - isReadOnly
```
boolean isReadOnly(AttributeI attr)
```
  - isMandatory
```
boolean isMandatory(AttributeI attr)
```
  - isVisible
```
boolean isVisible(AttributeI attr)
```
  - cancelCheckConstraints
```
boolean cancelCheckConstraints()
```
    should we check constraints (read only etc) before calling set/add/remove? (no, not during sync/replay)
  - hasTransientProperty
```
boolean hasTransientProperty(java.lang.String name)
```
    Returns true, if a transient property with the given name currently exists.
    
    Parameters:
    
    name - the name of the transient property that should be checked
    
    Returns:
    
    true, if a transient property with the given attrName currently exists
  - hasTransientPropertyUnfiltered
```
boolean hasTransientPropertyUnfiltered(java.lang.String name)
```
    Returns true, if a transient property with the given name exists or existed, i.e. not filtering out already expired versions.
    
    Parameters:
    
    name - the name of the transient property that should be checked
    
    Returns:
    
    true, if a transient property with the given attrName exists or existed
  - getTransientProperty
```
java.lang.Object getTransientProperty(java.lang.String name)
```
    Returns the value that was saved using the given transient property name.
    
    Parameters:
    
    name - the name of the transient property of which the value should be returned
    
    Returns:
    
    the value of the transient property with the provided name
  - setTransientProperty
```
java.lang.Object setTransientProperty(java.lang.String name,
                                      java.lang.Object value)
```
    Saves a transient value with the provided name for this BO. All values are put into a map using the name as key.
    Those values are only transient regarding the persistence in the database. Transient properties created by the client will never be available on the server.
    Upon frapping / deepCloning any stored value that cannot be serialized will be dropped and replaced by a null-value while logging a warning about that. So keep in mind that non-serializable transient properties might get "lost" then.
    
    Parameters:
    
    name - the name of the transient property
    
    value - the value of this property
    
    Returns:
    
    returns the value (as usually a method might end with setting a transient property and returning the very same value)
    
    See Also:
    
    BO.bumpVersion()
  - consumeAndAssureTransientPropertyExists
```
void consumeAndAssureTransientPropertyExists(java.lang.String name,
                                             java.util.function.Consumer<java.lang.Object[]> operation,
                                             java.lang.Object[] args)
```
    Performs the given Consumer operation on the passed args. If the specified transient property is not already present, it will be initialized with a null value.
    If the Consumer itself throws an (unchecked) exception, the exception is rethrown.
    Typically called for running default value expression and init script of scripted attributes.
  - getBOVersion
```
int getBOVersion()
```
    A value that is incremented each time the BO is modified.
  - bumpVersion
```
void bumpVersion()
```
    increase version value to signal a modification
  - toRelationMapRO
```
static java.util.Map<java.lang.Long,BOI> toRelationMapRO(java.util.Map<java.lang.Long,BOI> m)
```
    Returns an unmodifiable Map with the same entries as the passed Map, suitable for usage as return value of a getter for a read-only virtual relation. If no Map is passed or the passed Map is empty, the Collections.emptyMap() is returned.
  - contains
```
static boolean contains(java.util.Collection<?> haystack,
                        BOI needle)
```
  - hasBLOB
```
boolean hasBLOB()
```
  - getBLOB
```
long getBLOB(java.io.OutputStream target)
      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getBLOB
```
long getBLOB(java.io.OutputStream target,
             boolean closeOS)
      throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Interface BOI

Field Summary

Fields inherited from interface de.ipcon.schema.DescribableI

Fields inherited from interface de.ipcon.schema.SchemaProviderI

Method Summary

Methods inherited from interface de.ipcon.schema.Identifiable

Methods inherited from interface de.ipcon.schema.DescribableI

Field Detail

ENT_BO

ATT_Id

ATT_Crea

ATT_Lmod

ATT_Ldel

ATT_Bot

ATT_Procs

ATT_InvolvedInProcs

ATT_Badge

ATT_Badge2

ATT_Badge3

ATT_Badge4

ATT_CreatedBy

ATT_LastModifiedBy

ATT_BLOBCreatedBy

ATT_BLOBCreatedOn

ATT_BLOBDeletedBy

ATT_BLOBDeletedOn

ATT_BLOBLastModifiedBy

ATT_BLOBLastModifiedOn

ATT_CreatedModifiedText

EMPTY_ARRAY

Method Detail

equalsBO

equalsBO

getClazz

getCrea

getRootLoaderSchema

getSchema

getEntity

getEntity

getAttribute

getAttribute

isSubEntityOf

isSubEntityOf

isNew

isTemporary

isDeleted

isReadOnly

isMandatory

isVisible

cancelCheckConstraints

hasTransientProperty

hasTransientPropertyUnfiltered

getTransientProperty

setTransientProperty

consumeAndAssureTransientPropertyExists

getBOVersion

bumpVersion

toRelationMapRO

contains

hasBLOB

getBLOB

getBLOB