Interface ExpressionExperimentWriteAuditService

All Known Implementing Classes:

ExpressionExperimentWriteAuditServiceImpl

public interface ExpressionExperimentWriteAuditService

Co-bean for ExpressionExperimentWriteServiceImpl: a thin layer that exists so the preferred-QuantitationType change-audit methods are invoked through a Spring proxy, allowing the AuditedAspect to intercept the return path.

The two emission cases (inventory #15/#16 in AUDIT_RESIDUAL_INVENTORY.md) live in ExpressionExperimentWriteServiceImpl.updateQuantitationType(ExpressionExperiment, QuantitationType, QuantitationType) and pick the PreferredDataChangedEvent subclass at runtime from the data-vector type of the affected QT. The migration uses the valueSpel attribute on @Audited to express this runtime dispatch declaratively.

Method Summary

Modifier and Type	Method	Description
void	recordPreferredQtChanged(ExpressionExperiment ee, QuantitationType qt, QuantitationType previousPreferredQt, Class<? extends DataVector> vectorType)	Audit that the preferred QuantitationType for the given vector type changed to qt.
void	recordPreferredQtCleared(ExpressionExperiment ee, QuantitationType previousPreferredQt, Class<? extends DataVector> vectorType)	Audit that the preferred QuantitationType for the given vector type was cleared (the previously-preferred QT is no longer preferred).

Method Details

recordPreferredQtChanged

void recordPreferredQtChanged(ExpressionExperiment ee,
 QuantitationType qt,
 @Nullable
 QuantitationType previousPreferredQt,
 Class<? extends DataVector> vectorType)

Audit that the preferred QuantitationType for the given vector type changed to qt. The recorded event class is the PreferredDataChangedEvent subclass matching vectorType (see ExpressionExperimentWriteServiceImpl.getPreferredDataChangedEventForVectorType(Class)); the caller is responsible for not invoking this method when no event class exists for the vector type (e.g. processed data).

Parameters:

ee - the experiment whose preferred QT changed

qt - the new preferred QT

previousPreferredQt - the prior preferred QT (may be null)

vectorType - the data-vector type that drives event-class dispatch

recordPreferredQtCleared

void recordPreferredQtCleared(ExpressionExperiment ee,
 QuantitationType previousPreferredQt,
 Class<? extends DataVector> vectorType)

Audit that the preferred QuantitationType for the given vector type was cleared (the previously-preferred QT is no longer preferred). Same dispatch rule as recordPreferredQtChanged(ExpressionExperiment, QuantitationType, QuantitationType, Class).

Parameters:

ee - the experiment whose preferred QT was cleared

previousPreferredQt - the QT that used to be preferred (non-null)

vectorType - the data-vector type that drives event-class dispatch