de.ipcon.db.core

Class BOProc

java.lang.Object

de.ipcon.db.core.BOProc

All Implemented Interfaces:

BOProcI, WriteConstraintsOverriderI, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class BOProc
extends java.lang.Object
implements BOProcI, java.io.Externalizable, java.lang.Cloneable, WriteConstraintsOverriderI

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BOProc[]	EMPTY_ARRAY
static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
BOProc()
BOProc(BO _bO, de.ipcon.db.core.ProcType _procType, java.lang.String _attributeName, java.lang.Class _pt, java.lang.Object _op, java.lang.Object _np)
BOProc(BO _bO, de.ipcon.db.core.ProcType _procType, java.lang.String _attributeName, java.lang.Class _pt, java.lang.Object _op, java.lang.Object _np, ManagedFileI _handle)
BOProc(BO _bO, de.ipcon.db.core.ProcType _procType, java.lang.String _attributeName, java.lang.Class _pt, java.lang.Object _op, java.lang.Object _np, ManagedFileI _handle, boolean _fixing)
BOProc(BO _bO, de.ipcon.db.core.ProcType _procType, java.lang.String _attributeName, java.lang.Class _pt, java.lang.Object _op, java.lang.Object _np, ManagedFileI _handle, boolean _fixing, java.util.Date _localLmodOfBO)

Method Summary

Modifier and Type	Method and Description
void	announceBP(java.lang.Long bPId, java.lang.Long boId)
BOProc	backRelationInstance(SchemaI schema, BO affectedBO)
BOProc	clone()
void	commitBLOB()
int	compareByCreationMillis(BOProc second) Compares two BOProc instances by their creationMillis using ascending order
BOProc	createReverse() Creates the reverse BOProc instance and returns it, i.e. a 'forward' instance with the same 'replay' behaviour as this ones 'unplay'
boolean	disableAttributeWriteConstraints() Disables write constraints on attributes.
void	finishBLOB()
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.
java.lang.String	getAtt()
java.lang.String	getAttributeName()
BOProcI	getBackProc()
ManagedFileI	getBLOBHandle()
BO	getBO()
java.lang.Class	getBOClass()
java.lang.Long	getBOId()
long	getCreationMillis()
EntityI	getEntity(SchemaI schema) Deprecated. please use getAffectedEntity(SchemaI) instead.
java.util.Date	getLocalLmodOfBO()
java.lang.Object	getNativeNewValue()
java.lang.Object	getNativeOldValue()
java.lang.Object	getNewParm()
java.lang.String	getNewValue()
BOProcI	getNulledOldValueInstance()
java.lang.Object	getOldParm()
java.lang.String	getOldValue()
java.lang.Class	getParmTypeClass()
java.lang.Class	getPtyp()
BOProc	getStubbedInstance()
de.ipcon.db.core.ProcType	getType()
int	getTypeCode()
java.lang.String	getTypeName()
boolean	isCollateralChangeWhileSaving()
boolean	isFixing()
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO, java.lang.Long boId)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO, java.lang.Long boId, BLOBLoaderI blobLoader)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO, java.lang.Long boId, BLOBLoaderI blobLoader, ServerFileVaultI fileVault)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO, java.lang.Long boId, BLOBLoaderI blobLoader, ServerFileVaultI fileVault, BP backuppingBP)
static BOProc	of(SchemaI schema, BOLoaderI loader, BOProcI bp, BO explicitBO, java.lang.Long boId, BLOBLoaderI blobLoader, ServerFileVaultI fileVault, BP backuppingBP, boolean fixingMode)
static BOProc	ofFixing(SchemaI schema, BOLoaderI loader, BP bp) Returns a new instance of BOProc reflecting the changes in the passed BP.
static BOProc	ofPurging(BO _bO) Creates a new `BOProc` instance representing the purging of a Business Object (BO).
void	playStreamOp()
void	precommitBLOB()
void	readExternal(java.io.ObjectInput s)
void	readInstance(SecureObjectInputI s, java.util.ArrayList<BO> boList, SchemaI schema, boolean stubClone, boolean forDeepClone, boolean syncMode, FileVaultI fileVault)
void	replay(SchemaI schema) Replay method to apply the changes in this proc onto the current BO.
void	replayInExistingCachedBOGraph(SchemaI schema) Like replay(SchemaI), but does a simplified unplay first.
void	rollbackBLOB()
void	setAtt(java.lang.String $13)
void	setBackProc(BOProcI $21)
void	setBLOBHandle(ManagedFileI $20)
void	setBO(BO $12)
void	setCollateralChangeWhileSaving(boolean $18)
void	setFixing(boolean $17)
void	setLocalLmodOfBO(java.util.Date $19)
void	setNewParm(java.lang.Object $15)
void	setOldParm(java.lang.Object $16)
void	setPtyp(java.lang.Class $14)
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	setType(de.ipcon.db.core.ProcType $11)
java.lang.String	toString()
void	unplay(SchemaI schema) Sets the current BO attribute to the values it had before the current Proc
void	unplayStreamOp()
void	warn(java.lang.String msg) Logs a warning message using the logger associated with this `BOProcI`.
void	writeExternal(java.io.ObjectOutput s)
void	writeInstance(SecureObjectOutputI s, java.util.HashMap<BO,java.lang.Integer> indexMap, SchemaI schema, boolean stubClone, boolean noBLOBTransfer, boolean syncMode)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

appendTo, appendTo, appendTo, appendTo, appendTo, appendTo, appendTo, containsRelevant1toNChangesFor, containsRelevantChangesFor, containsRelevantNto1ChangesFor, containsRelevantNtoMChangesFor, getAffectedIds, getAttribute, getRelevantChangesFor, isAddition, isAnyAffectedIdKnownTo, isBLOBChange, isBLOBCreation, isBLOBDeletion, isChange, isChangeTo, isCreation, isDeletion, isDeletionFlagChange, isDependentManyRelationChange, isForbiddenChange, isForbiddenChange, isKeepNoBLOBHistory, isManyRelationChange, isManyToManyChange, isManyToOneChange, isOneToManyChange, isPurging, isRelationChange, isRelevantRelationalChangeFor, isRelevantRelationalChangeForTE, isRemoval, isSettingValue, isSimpleChange, isUndeletion

Methods inherited from interface de.ipcon.schema.WriteConstraintsOverriderI

getLogLevelForDisableAttributeWriteConstraints

Field Detail

log

public static final org.apache.log4j.Logger log

EMPTY_ARRAY

public static final BOProc[] EMPTY_ARRAY

Constructor Detail

BOProc

public BOProc()

BOProc

public BOProc(BO _bO,
              de.ipcon.db.core.ProcType _procType,
              java.lang.String _attributeName,
              java.lang.Class _pt,
              java.lang.Object _op,
              java.lang.Object _np)

BOProc

public BOProc(BO _bO,
              de.ipcon.db.core.ProcType _procType,
              java.lang.String _attributeName,
              java.lang.Class _pt,
              java.lang.Object _op,
              java.lang.Object _np,
              ManagedFileI _handle)

BOProc

public BOProc(BO _bO,
              de.ipcon.db.core.ProcType _procType,
              java.lang.String _attributeName,
              java.lang.Class _pt,
              java.lang.Object _op,
              java.lang.Object _np,
              ManagedFileI _handle,
              boolean _fixing)

BOProc

public BOProc(BO _bO,
              de.ipcon.db.core.ProcType _procType,
              java.lang.String _attributeName,
              java.lang.Class _pt,
              java.lang.Object _op,
              java.lang.Object _np,
              ManagedFileI _handle,
              boolean _fixing,
              java.util.Date _localLmodOfBO)

Method Detail

ofFixing

public static BOProc ofFixing(SchemaI schema,
                              BOLoaderI loader,
                              BP bp)

Returns a new instance of BOProc reflecting the changes in the passed BP. Marks the BOProc as fixing. Called in sync-mode, whenever a fixing BOProc is needed to keep the data consistent, if older changes are synced in, which have already been overwritten locally. In that case the newer local change in the passed BP is incorporated into the synced in transaction.

ofPurging

public static BOProc ofPurging(BO _bO)

Creates a new `BOProc` instance representing the purging of a Business Object (BO).

This method constructs a `BOProc` with the specified BO and sets its processing type to `ProcType.PURGE`. The remaining parameters (attribute name, parameter type, old parameter value and new parameter value) are set to `null`, as they are not relevant for a purge operation.

Parameters:

_bO - The BO that is being purged.

Returns:

A new `BOProc` instance representing the purging of the specified BO.

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO,
                        java.lang.Long boId)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO,
                        java.lang.Long boId,
                        BLOBLoaderI blobLoader)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO,
                        java.lang.Long boId,
                        BLOBLoaderI blobLoader,
                        ServerFileVaultI fileVault)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO,
                        java.lang.Long boId,
                        BLOBLoaderI blobLoader,
                        ServerFileVaultI fileVault,
                        BP backuppingBP)

of

public static BOProc of(SchemaI schema,
                        BOLoaderI loader,
                        BOProcI bp,
                        BO explicitBO,
                        java.lang.Long boId,
                        BLOBLoaderI blobLoader,
                        ServerFileVaultI fileVault,
                        BP backuppingBP,
                        boolean fixingMode)

warn

public void warn(java.lang.String msg)

Description copied from interface: BOProcI

Logs a warning message using the logger associated with this `BOProcI`.

Specified by:

warn in interface BOProcI

Parameters:

msg - The warning message to be logged

getNulledOldValueInstance

public BOProcI getNulledOldValueInstance()

Specified by:

getNulledOldValueInstance in interface BOProcI

disableAttributeWriteConstraints

public boolean disableAttributeWriteConstraints()

Description copied from interface: WriteConstraintsOverriderI

Disables write constraints on attributes.

This method temporarily disables any write constraints that might be in place for attributes. This allows for modifying attributes that would normally be restricted via read-only.

Specified by:

disableAttributeWriteConstraints in interface WriteConstraintsOverriderI

Returns:

true if write constraints shall be disabled, false otherwise.

getAttributeName

public java.lang.String getAttributeName()

Specified by:

getAttributeName in interface BOProcI

getTypeCode

public int getTypeCode()

Specified by:

getTypeCode in interface BOProcI

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface BOProcI

getParmTypeClass

public java.lang.Class getParmTypeClass()

Specified by:

getParmTypeClass in interface BOProcI

getNativeOldValue

public java.lang.Object getNativeOldValue()

Specified by:

getNativeOldValue in interface BOProcI

getOldValue

public java.lang.String getOldValue()

Specified by:

getOldValue in interface BOProcI

getNativeNewValue

public java.lang.Object getNativeNewValue()

Specified by:

getNativeNewValue in interface BOProcI

getNewValue

public java.lang.String getNewValue()

Specified by:

getNewValue in interface BOProcI

setsBooleanToTrue

public boolean setsBooleanToTrue(java.lang.String attrName)

Description copied from interface: BOProcI

Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to true.

Specified by:

setsBooleanToTrue in interface BOProcI

setsBooleanToFalse

public boolean setsBooleanToFalse(java.lang.String attrName)

Description copied from interface: BOProcI

Returns true if this BOProcI represents a change of the value of the attribute represented by the given attrName to false.

Specified by:

setsBooleanToFalse in interface BOProcI

setsBooleanToFalse

public boolean setsBooleanToFalse(java.lang.String attrName,
                                  boolean alsoIfAttrWasSetToNull)

Description copied from interface: BOProcI

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

Specified by:

setsBooleanToFalse in interface BOProcI

getCreationMillis

public long getCreationMillis()

getBOId

public java.lang.Long getBOId()

Specified by:

getBOId in interface BOProcI

getBOClass

public java.lang.Class getBOClass()

Specified by:

getBOClass in interface BOProcI

getStubbedInstance

public BOProc getStubbedInstance()

clone

public BOProc clone()

Overrides:

clone in class java.lang.Object

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeInstance

public void writeInstance(SecureObjectOutputI s,
                          java.util.HashMap<BO,java.lang.Integer> indexMap,
                          SchemaI schema,
                          boolean stubClone,
                          boolean noBLOBTransfer,
                          boolean syncMode)
                   throws java.io.IOException

Throws:

java.io.IOException

readInstance

public void readInstance(SecureObjectInputI s,
                         java.util.ArrayList<BO> boList,
                         SchemaI schema,
                         boolean stubClone,
                         boolean forDeepClone,
                         boolean syncMode,
                         FileVaultI fileVault)
                  throws java.lang.ClassNotFoundException,
                         java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

replayInExistingCachedBOGraph

public void replayInExistingCachedBOGraph(SchemaI schema)

Like replay(SchemaI), but does a simplified unplay first. This is to make sure that any backrelations in the Cached BO Graph will get updated as well.

replay

public void replay(SchemaI schema)

Replay method to apply the changes in this proc onto the current BO.

unplay

public void unplay(SchemaI schema)

Sets the current BO attribute to the values it had before the current Proc

getEntity

@Deprecated
public EntityI getEntity(SchemaI schema)

Deprecated. please use getAffectedEntity(SchemaI) instead.

getAffectedEntity

public EntityI getAffectedEntity(SchemaI schema)

Description copied from interface: BOProcI

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.

Specified by:

getAffectedEntity in interface BOProcI

Parameters:

schema - The schema to use.

Returns:

The `EntityI` affected by this `BOProcI`.

backRelationInstance

public BOProc backRelationInstance(SchemaI schema,
                                   BO affectedBO)

createReverse

public BOProc createReverse()

Creates the reverse BOProc instance and returns it, i.e. a 'forward' instance with the same 'replay' behaviour as this ones 'unplay'

announceBP

public void announceBP(java.lang.Long bPId,
                       java.lang.Long boId)

precommitBLOB

public void precommitBLOB()
                   throws java.io.IOException

Throws:

java.io.IOException

commitBLOB

public void commitBLOB()
                throws java.io.IOException

Throws:

java.io.IOException

rollbackBLOB

public void rollbackBLOB()
                  throws java.io.IOException

Throws:

java.io.IOException

finishBLOB

public void finishBLOB()
                throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

playStreamOp

public void playStreamOp()

unplayStreamOp

public void unplayStreamOp()

compareByCreationMillis

public int compareByCreationMillis(BOProc second)

Compares two BOProc instances by their creationMillis using ascending order

getType

public de.ipcon.db.core.ProcType getType()

Specified by:

getType in interface BOProcI

setType

public void setType(de.ipcon.db.core.ProcType $11)

getBO

public BO getBO()

Specified by:

getBO in interface BOProcI

setBO

public void setBO(BO $12)

getAtt

public java.lang.String getAtt()

setAtt

public void setAtt(java.lang.String $13)

getPtyp

public java.lang.Class getPtyp()

setPtyp

public void setPtyp(java.lang.Class $14)

getNewParm

public java.lang.Object getNewParm()

setNewParm

public void setNewParm(java.lang.Object $15)

getOldParm

public java.lang.Object getOldParm()

setOldParm

public void setOldParm(java.lang.Object $16)

isFixing

public boolean isFixing()

setFixing

public void setFixing(boolean $17)

isCollateralChangeWhileSaving

public boolean isCollateralChangeWhileSaving()

setCollateralChangeWhileSaving

public void setCollateralChangeWhileSaving(boolean $18)

getLocalLmodOfBO

public java.util.Date getLocalLmodOfBO()

setLocalLmodOfBO

public void setLocalLmodOfBO(java.util.Date $19)

getBLOBHandle

public ManagedFileI getBLOBHandle()

setBLOBHandle

public void setBLOBHandle(ManagedFileI $20)

getBackProc

public BOProcI getBackProc()

Specified by:

getBackProc in interface BOProcI

setBackProc

public void setBackProc(BOProcI $21)

Specified by:

setBackProc in interface BOProcI