BOProcI (MyTISM API Documentation)

All Known Implementing Classes:

BOProc, BP
```
public interface BOProcI
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String $0

static BOProcI[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`$0`
`static BOProcI[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html, boolean hideBO)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html, boolean hideBO, int maxCharsForDescription)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html, boolean hideBO, int maxCharsForDescription, de.ipcon.db.core.BOSet introSet)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html, boolean hideBO, int maxCharsForDescription, de.ipcon.db.core.BOSet introSet, boolean asSubGroupHeader, int countSubGroupChanges)` Appends a user-readable description of this BOProcI to the given Appendable.
`default void`	`appendTo(java.lang.Appendable app, SchemaI schema, boolean html, boolean hideBO, int maxCharsForDescription, de.ipcon.db.core.BOSet introSet, boolean asSubGroupHeader, int countSubGroupChanges, boolean asSubGroupItem)` Appends a user-readable description of this BOProcI to the given Appendable.
`static boolean`	`containsRelevant1toNChangesFor(AttributeI a, BO changedBO, BO newValueBO)` Determines if this `BOProcI` contains changes to 1-n relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
`default boolean`	`containsRelevantChangesFor(BOLoaderWithCacheI loaderWithCache)` Determines if this `BOProcI` contains changes that are relevant to the cache of the specified `BOLoaderWithCacheI`.
`static boolean`	`containsRelevantNto1ChangesFor(AttributeI a, BO changedBO, BO newValueBO)` Determines if this `BOProcI` contains changes to n-1 relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
`static boolean`	`containsRelevantNtoMChangesFor(AttributeI a, BO changedBO, BO newValueBO, boolean isRemoval)` Determines if this `BOProcI` contains changes to n-m relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
`EntityI`	`getAffectedEntity(SchemaI schema)` Retrieves the `EntityI` that is directly impacted by the changes represented by this `BOProcI`, i.e. the entity of the modified BO.
`default java.util.List<java.lang.Long>`	`getAffectedIds(SchemaI schema)` Retrieves the Ids of the Business Objects (BOs) affected by this BOProcI.
`default AttributeI`	`getAttribute(SchemaI schema)`
`java.lang.String`	`getAttributeName()`
`BOProcI`	`getBackProc()`
`BO`	`getBO()`
`java.lang.Class`	`getBOClass()`
`java.lang.Long`	`getBOId()`
`java.lang.Object`	`getNativeNewValue()`
`java.lang.Object`	`getNativeOldValue()`
`java.lang.String`	`getNewValue()`
`BOProcI`	`getNulledOldValueInstance()`
`java.lang.String`	`getOldValue()`
`java.lang.Class`	`getParmTypeClass()`
`default BOProcI`	`getRelevantChangesFor(BOLoaderWithCacheI loaderWithCache)` Retrieves the relevant changes for a cached BO within the given `BOLoaderWithCacheI`.
`de.ipcon.db.core.ProcType`	`getType()`
`int`	`getTypeCode()`
`java.lang.String`	`getTypeName()`
`default boolean`	`isAddition()` Returns `true` if this BOProc represents adding an element for a relation attribute.
`default boolean`	`isAnyAffectedIdKnownTo(BOLoaderWithCacheI loaderWithCache)` Checks if any of the affected BO Ids are known to the specified `BOLoaderWithCacheI`.
`default boolean`	`isBLOBChange()` Returns `true` if this BOProcI represents a BLOB operation.
`default boolean`	`isBLOBCreation()` Returns `true` if this BOProcI represents a BLOB creation.
`default boolean`	`isBLOBDeletion()` Returns `true` if this BOProcI represents a BLOB deletion.
`default boolean`	`isChange()` Returns `true` if this BOProcI represents some change (new value for a "primitive" attribute or adding or removing an element for a relation attribute).
`default boolean`	`isChangeTo(java.lang.String attrName)` Returns true if this BOProcI represents a change to an attribute with the given name.
`default boolean`	`isCreation()` Returns `true` if this BOProcI represents the creation of a new BO.
`default boolean`	`isDeletion()` Returns `true` if this BOProcI represents the deletion of a BO.
`default boolean`	`isDeletionFlagChange()` Returns `true` if this BOProcI does something with the Ldel flag
`default boolean`	`isDependentManyRelationChange(SchemaI schema)` Returns `true` if this BOProcI represents a change to a dependent many-relation.
`default boolean`	`isForbiddenChange(SchemaI schema)` Checks if modifications to the entity associated with this `BOProcI` are prohibited.
`default boolean`	`isForbiddenChange(SchemaI schema, boolean signalIfForbiddenChange)`
`default boolean`	`isKeepNoBLOBHistory(SchemaI schema)` Checks if the associated entity is configured to not keep a history of its stream resource (BLOB).
`default boolean`	`isManyRelationChange()` Returns `true` if this BOProcI represents a change to a many-relation, i.e. adding or removing an element for a relation attribute.
`default boolean`	`isManyToManyChange(SchemaI schema)` Returns `true` if this BOProcI represents a change to a many-to-many-relation, i.e. adding or removing an element for a n-m-relation attribute.
`default boolean`	`isManyToOneChange(SchemaI schema)` Returns `true` if this BOProcI represents a change to a many-to-one relation, i.e. setting an element for an n-1-relation attribute.
`default boolean`	`isOneToManyChange(SchemaI schema)` Returns `true` if this BOProcI represents a change to a one-to-many-relation, i.e. adding or removing an element for a 1-n-relation attribute.
`default boolean`	`isPurging()` Returns `true` if this BOProcI represents the purging of a BO from the database.
`default boolean`	`isRelationChange(SchemaI schema)` Returns `true` if this BOProcI represents a change to relation
`default boolean`	`isRelevantRelationalChangeFor(BO bo, java.lang.String attrName)` Determines if this `BOProcI` represents a relational change for a specific BO and attribute, handling potential attribute resolution errors.
`default boolean`	`isRelevantRelationalChangeForTE(BO bo, java.lang.String attrName)` Determines if this `BOProcI` represents a relational change for a specific BO and attribute.
`default boolean`	`isRemoval()` Returns `true` if this BOProc represents removing an element for a relation attribute.
`default boolean`	`isSettingValue()` Returns `true` if this BOProc represents setting a value
`default boolean`	`isSimpleChange()` Returns `true` if this BOProcI represents some simple change (new value for a "primitive" or "n-1" attribute).
`default boolean`	`isUndeletion()` Returns `true` if this BOProcI represents the undeletion of a BO.
`void`	`setBackProc(BOProcI p)`
`boolean`	`setsBooleanToFalse(java.lang.String attrName)` Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to false.
`boolean`	`setsBooleanToFalse(java.lang.String attrName, boolean alsoIfAttrWasSetToNull)` Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to false.
`boolean`	`setsBooleanToTrue(java.lang.String attrName)` Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to true.
`void`	`warn(java.lang.String msg)` Logs a warning message using the logger associated with this `BOProcI`.

- Field Detail
  - $0
```
static final java.lang.String $0
```
    See Also:
    
    Constant Field Values
  - EMPTY_ARRAY
```
static final BOProcI[] EMPTY_ARRAY
```
- Method Detail
  - getNulledOldValueInstance
```
BOProcI getNulledOldValueInstance()
```
  - getBOId
```
java.lang.Long getBOId()
```
  - getBOClass
```
java.lang.Class getBOClass()
```
  - getBO
```
BO getBO()
```
  - getAttributeName
```
java.lang.String getAttributeName()
```
  - getAttribute
```
default AttributeI getAttribute(SchemaI schema)
```
  - getAffectedEntity
```
EntityI getAffectedEntity(SchemaI schema)
```
    Retrieves the `EntityI` that is directly impacted by the changes represented by this `BOProcI`, i.e. the entity of the modified BO.
    This method identifies the specific entity within the schema that is affected by the business object procedure represented by this `BOProcI`. The `schema` parameter provides the context for resolving the entity.
    
    Parameters:
    
    schema - The schema to use.
    
    Returns:
    
    The `EntityI` affected by this `BOProcI`.
  - getType
```
de.ipcon.db.core.ProcType getType()
```
  - getTypeCode
```
int getTypeCode()
```
  - getTypeName
```
java.lang.String getTypeName()
```
  - getParmTypeClass
```
java.lang.Class getParmTypeClass()
```
  - getNativeOldValue
```
java.lang.Object getNativeOldValue()
```
  - getOldValue
```
java.lang.String getOldValue()
```
  - getNativeNewValue
```
java.lang.Object getNativeNewValue()
```
  - getNewValue
```
java.lang.String getNewValue()
```
  - isCreation
```
default boolean isCreation()
```
    Returns true if this BOProcI represents the creation of a new BO.
  - isPurging
```
default boolean isPurging()
```
    Returns true if this BOProcI represents the purging of a BO from the database.
  - isDeletion
```
default boolean isDeletion()
```
    Returns true if this BOProcI represents the deletion of a BO.
  - isUndeletion
```
default boolean isUndeletion()
```
    Returns true if this BOProcI represents the undeletion of a BO.
  - isSettingValue
```
default boolean isSettingValue()
```
    Returns true if this BOProc represents setting a value
  - isAddition
```
default boolean isAddition()
```
    Returns true if this BOProc represents adding an element for a relation attribute.
  - isRemoval
```
default boolean isRemoval()
```
    Returns true if this BOProc represents removing an element for a relation attribute.
  - isChange
```
default boolean isChange()
```
    Returns true if this BOProcI represents some change (new value for a "primitive" attribute or adding or removing an element for a relation attribute).
  - isChangeTo
```
default boolean isChangeTo(java.lang.String attrName)
```
    Returns true if this BOProcI represents a change to an attribute with the given name.
  - isForbiddenChange
```
default boolean isForbiddenChange(SchemaI schema)
```
    Checks if modifications to the entity associated with this `BOProcI` are prohibited.
    This method verifies if the associated entity returns true for `isForbidDirectChanges`. If so, and `signalIfForbiddenChange` is also true, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    schema - The schema to use.
    
    signalIfForbiddenChange - If true, an IllegalArgumentException will be thrown if changes are forbidden; otherwise, only a boolean result is returned.
    
    Returns:
    
    true if modifications to the entity are forbidden, false otherwise.
    
    Throws:
    
    java.lang.IllegalArgumentException - If `signalIfForbiddenChange` is true and the entity is configured to forbid direct changes.
  - isForbiddenChange
```
default boolean isForbiddenChange(SchemaI schema,
                                  boolean signalIfForbiddenChange)
```
  - isSimpleChange
```
default boolean isSimpleChange()
```
    Returns true if this BOProcI represents some simple change (new value for a "primitive" or "n-1" attribute).
  - isDeletionFlagChange
```
default boolean isDeletionFlagChange()
```
    Returns true if this BOProcI does something with the Ldel flag
  - setsBooleanToTrue
```
boolean setsBooleanToTrue(java.lang.String attrName)
```
    Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to true.
  - setsBooleanToFalse
```
boolean setsBooleanToFalse(java.lang.String attrName,
                           boolean alsoIfAttrWasSetToNull)
```
    Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to false. If alsoIfAttrWasSetToNull is true, will also return true if the attrName was set to null (which in most cases is also interpreted as value false).
  - setsBooleanToFalse
```
boolean setsBooleanToFalse(java.lang.String attrName)
```
    Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to false.
  - isRelationChange
```
default boolean isRelationChange(SchemaI schema)
```
    Returns true if this BOProcI represents a change to relation
  - isManyRelationChange
```
default boolean isManyRelationChange()
```
    Returns true if this BOProcI represents a change to a many-relation, i.e. adding or removing an element for a relation attribute.
  - isOneToManyChange
```
default boolean isOneToManyChange(SchemaI schema)
```
    Returns true if this BOProcI represents a change to a one-to-many-relation, i.e. adding or removing an element for a 1-n-relation attribute.
  - isManyToOneChange
```
default boolean isManyToOneChange(SchemaI schema)
```
    Returns true if this BOProcI represents a change to a many-to-one relation, i.e. setting an element for an n-1-relation attribute.
  - isManyToManyChange
```
default boolean isManyToManyChange(SchemaI schema)
```
    Returns true if this BOProcI represents a change to a many-to-many-relation, i.e. adding or removing an element for a n-m-relation attribute.
  - isDependentManyRelationChange
```
default boolean isDependentManyRelationChange(SchemaI schema)
```
    Returns true if this BOProcI represents a change to a dependent many-relation.
  - isRelevantRelationalChangeForTE
```
default boolean isRelevantRelationalChangeForTE(BO bo,
                                                java.lang.String attrName)
                                         throws AttributeResolveException
```
    Determines if this `BOProcI` represents a relational change for a specific BO and attribute.
    This method checks if the `BOProcI` modifies the attribute specified by `attrName` of the given BO . It signals an `AttributeResolveException` if there's an issue resolving the attribute.
    
    Parameters:
    
    bo - The Business Object (BO) to check for relational changes.
    
    attrName - The name of the attribute representing the relationship.
    
    Returns:
    
    true if this `BOProcI` represents a relational change of the given BO and attribute, false otherwise.
    
    Throws:
    
    AttributeResolveException - If the attribute cannot be resolved.
  - isRelevantRelationalChangeFor
```
default boolean isRelevantRelationalChangeFor(BO bo,
                                              java.lang.String attrName)
```
    Determines if this `BOProcI` represents a relational change for a specific BO and attribute, handling potential attribute resolution errors.
    This method is similar to isRelevantRelationalChangeForTE(BO, String), but it catches and handles `AttributeResolveException` gracefully, returning false in case of such an error.
    
    Parameters:
    
    bo - The Business Object (BO) to check for relational changes.
    
    attrName - The name of the attribute representing the relationship.
    
    Returns:
    
    true if this `BOProcI` represents a relational change of the given BO and attribute, false otherwise or if there's an attribute resolution error.
  - isBLOBChange
```
default boolean isBLOBChange()
```
    Returns true if this BOProcI represents a BLOB operation.
  - isBLOBCreation
```
default boolean isBLOBCreation()
```
    Returns true if this BOProcI represents a BLOB creation.
  - isBLOBDeletion
```
default boolean isBLOBDeletion()
```
    Returns true if this BOProcI represents a BLOB deletion.
  - isKeepNoBLOBHistory
```
default boolean isKeepNoBLOBHistory(SchemaI schema)
```
    Checks if the associated entity is configured to not keep a history of its stream resource (BLOB).
    This method checks if the `EntityI` associated with this `BOProcI` has been set to discard its stream resource history. In such a configuration, any new stream resource replaces the existing one without creating backups.
    
    Parameters:
    
    schema - The schema containing the entity definitions.
    
    Returns:
    
    true if the entity is configured to keep no BLOB history, false otherwise.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html,
                      boolean hideBO,
                      int maxCharsForDescription,
                      de.ipcon.db.core.BOSet introSet,
                      boolean asSubGroupHeader,
                      int countSubGroupChanges,
                      boolean asSubGroupItem)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html,
                      boolean hideBO,
                      int maxCharsForDescription,
                      de.ipcon.db.core.BOSet introSet,
                      boolean asSubGroupHeader,
                      int countSubGroupChanges)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html,
                      boolean hideBO,
                      int maxCharsForDescription,
                      de.ipcon.db.core.BOSet introSet)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html,
                      boolean hideBO,
                      int maxCharsForDescription)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html,
                      boolean hideBO)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema,
                      boolean html)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - appendTo
```
default void appendTo(java.lang.Appendable app,
                      SchemaI schema)
```
    Appends a user-readable description of this BOProcI to the given Appendable.
  - warn
```
void warn(java.lang.String msg)
```
    Logs a warning message using the logger associated with this `BOProcI`.
    
    Parameters:
    
    msg - The warning message to be logged
  - setBackProc
```
void setBackProc(BOProcI p)
```
  - getBackProc
```
BOProcI getBackProc()
```
  - getRelevantChangesFor
```
default BOProcI getRelevantChangesFor(BOLoaderWithCacheI loaderWithCache)
```
    Retrieves the relevant changes for a cached BO within the given `BOLoaderWithCacheI`.
    This method filters the changes represented by this `BOProcI` to include only those that are relevant to a cached BO in the specified loader. It either returns this `BOProcI` instance directly if all changes are relevant or a trimmed-down copy containing only the necessary references to relevant BOs.
    
    Parameters:
    
    loaderWithCache - The `BOLoaderWithCacheI` for which to determine relevant changes.
    
    Returns:
    
    This `BOProcI` if all changes are relevant, a trimmed copy with only relevant changes, or `null` if no changes are relevant to the cached BO.
  - containsRelevantChangesFor
```
default boolean containsRelevantChangesFor(BOLoaderWithCacheI loaderWithCache)
```
    Determines if this `BOProcI` contains changes that are relevant to the cache of the specified `BOLoaderWithCacheI`.
    
    Parameters:
    
    loaderWithCache - The `BOLoaderWithCacheI` to check against.
    
    Returns:
    
    true if this `BOProcI` has changes relevant to the cache, false otherwise.
  - containsRelevantNto1ChangesFor
```
static boolean containsRelevantNto1ChangesFor(AttributeI a,
                                              BO changedBO,
                                              BO newValueBO)
```
    Determines if this `BOProcI` contains changes to n-1 relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
    
    Parameters:
    
    a - the n-1 attribute that should be changed, nonnull.
    
    changedBO - the BO the attribute belongs to. null is interpreted as "This value is unknown to the cache".
    
    newValueBO - the BO that should be added or removed. null is interpreted as "This value is unknown to the cache".
    
    Returns:
    
    true if this `BOProcI` has changes to n-1 relations relevant to the cache, false otherwise.
  - containsRelevant1toNChangesFor
```
static boolean containsRelevant1toNChangesFor(AttributeI a,
                                              BO changedBO,
                                              BO newValueBO)
```
    Determines if this `BOProcI` contains changes to 1-n relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
    
    Parameters:
    
    a - the 1-n attribute that should be changed, nonnull.
    
    changedBO - the BO the attribute belongs to. null is interpreted as "This value is unknown to the cache".
    
    newValueBO - the BO that should be added or removed. null is interpreted as "This value is unknown to the cache".
    
    Returns:
    
    true if this `BOProcI` has changes to 1-n relations relevant to the cache, false otherwise.
  - containsRelevantNtoMChangesFor
```
static boolean containsRelevantNtoMChangesFor(AttributeI a,
                                              BO changedBO,
                                              BO newValueBO,
                                              boolean isRemoval)
```
    Determines if this `BOProcI` contains changes to n-m relations that are relevant to the cache of the specified `BOLoaderWithCacheI`.
    
    Parameters:
    
    a - the n-m attribute that should be changed, nonnull.
    
    changedBO - the BO the attribute belongs to. null is interpreted as "This value is unknown to the cache".
    
    newValueBO - the BO that should be added or removed. null is interpreted as "This value is unknown to the cache".
    
    isRemoval - true if the BOs should no longer related, false otherwise.
    
    Returns:
    
    true if this `BOProcI` has changes to n-m relations relevant to the cache, false otherwise.
  - isAnyAffectedIdKnownTo
```
default boolean isAnyAffectedIdKnownTo(BOLoaderWithCacheI loaderWithCache)
```
    Checks if any of the affected BO Ids are known to the specified `BOLoaderWithCacheI`.
    This method provides a basic check to determine if at least one of the BOs affected by this `BOProcI` is present in the cache of the given loader, as that may lead to memory leaks due to the retention of the objects in the procs.
    
    Parameters:
    
    loaderWithCache - The `BOLoaderWithCacheI` to check against.
    
    Returns:
    
    true if at least one affected BO Id is known to the loader, false otherwise.
  - getAffectedIds
```
default java.util.List<java.lang.Long> getAffectedIds(SchemaI schema)
```
    Retrieves the Ids of the Business Objects (BOs) affected by this BOProcI.
    
    Parameters:
    
    schema - The schema to use for accessing metadata.
    
    Returns:
    
    A list of Ids of the affected BOs.

Interface BOProcI

Field Summary

Method Summary

Field Detail

$0

EMPTY_ARRAY

Method Detail

getNulledOldValueInstance

getBOId

getBOClass

getBO

getAttributeName

getAttribute

getAffectedEntity

getType

getTypeCode

getTypeName

getParmTypeClass

getNativeOldValue

getOldValue

getNativeNewValue

getNewValue

isCreation

isPurging

isDeletion

isUndeletion

isSettingValue

isAddition

isRemoval

isChange

isChangeTo

isForbiddenChange

isForbiddenChange

isSimpleChange

isDeletionFlagChange

setsBooleanToTrue

setsBooleanToFalse

setsBooleanToFalse

isRelationChange

isManyRelationChange

isOneToManyChange

isManyToOneChange

isManyToManyChange

isDependentManyRelationChange

isRelevantRelationalChangeForTE

isRelevantRelationalChangeFor

isBLOBChange

isBLOBCreation

isBLOBDeletion

isKeepNoBLOBHistory

appendTo

appendTo

appendTo

appendTo

appendTo

appendTo

appendTo

warn

setBackProc

getBackProc

getRelevantChangesFor

containsRelevantChangesFor

containsRelevantNto1ChangesFor

containsRelevant1toNChangesFor

containsRelevantNtoMChangesFor

isAnyAffectedIdKnownTo

getAffectedIds