ch.agent.crnickl.impl

Interface ChronicleUpdatePolicy

All Superinterfaces:

UpdatePolicy

All Known Subinterfaces:

ChronicleUpdatePolicyExtension

All Known Implementing Classes:

ChronicleUpdatePolicyImpl

public interface ChronicleUpdatePolicy
extends UpdatePolicy

A ChronicleUpdatePolicy supports the delegation of various decisions and actions when updating chronicles and series. There is a related interface ChronicleUpdatePolicyExtension which declares the same methods. Implementations of this interface take care of invoking corresponding methods in the extension interface.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
boolean	deleteChronicle(UpdatableChronicle chronicle) Perform actions required as a consequence of deleting a chronicle.
boolean	deleteSeries(UpdatableSeries<?> series) Perform actions required as a consequence of deleting a series.
boolean	deleteValue(UpdatableSeries<?> series, ch.agent.t2.time.TimeIndex index) Perform actions required as a consequence of deleting a value.
boolean	update(UpdatableSeries<?> series, ch.agent.t2.time.Range range) Perform actions required as a consequence of updating the range of a series.
void	willDelete(UpdatableChronicle chronicle) Throw an exception if the chronicle cannot be deleted.
void	willDelete(UpdatableSeries<?> series) Throw an exception if the series cannot be deleted.
void	willDelete(UpdatableSeries<?> series, ch.agent.t2.time.TimeIndex index) Throw an exception if the value cannot be deleted.
void	willUpdate(UpdatableChronicle chronicle) Throw an exception if the intended update is rejected.
void	willUpdate(UpdatableSeries<?> series, ch.agent.t2.time.Range range) Throw an exception if the intended update is rejected.

Method Detail

willUpdate

void willUpdate(UpdatableChronicle chronicle)
         throws T2DBException

Throw an exception if the intended update is rejected.

Parameters:

chronicle - a chronicle

Throws:

T2DBException

willUpdate

void willUpdate(UpdatableSeries<?> series,
                ch.agent.t2.time.Range range)
         throws T2DBException

Throw an exception if the intended update is rejected.

Parameters:

series - a series

range - the new range

Throws:

T2DBException

willDelete

void willDelete(UpdatableChronicle chronicle)
         throws T2DBException

Throw an exception if the chronicle cannot be deleted. Typically, it is not possible to delete something when important dependent objects exist.

Parameters:

chronicle - a chronicle

Throws:

T2DBException

willDelete

void willDelete(UpdatableSeries<?> series)
         throws T2DBException

Throw an exception if the series cannot be deleted. Typically, it is not possible to delete something when important dependent objects exist.

Parameters:

series - a series

Throws:

T2DBException

willDelete

void willDelete(UpdatableSeries<?> series,
                ch.agent.t2.time.TimeIndex index)
         throws T2DBException

Throw an exception if the value cannot be deleted. Typically, it is not possible to delete something when important dependent objects exist.

Parameters:

series - a series

index - a time index

Throws:

T2DBException

deleteChronicle

boolean deleteChronicle(UpdatableChronicle chronicle)
                 throws T2DBException

Perform actions required as a consequence of deleting a chronicle. Return true if something was done.

The method does not manage relationships or dependencies in the core system. Its responsibility is to call the relevant extension methods.

Parameters:

chronicle - a chronicle

Returns:

true is anything was done

Throws:

T2DBException

deleteSeries

boolean deleteSeries(UpdatableSeries<?> series)
              throws T2DBException

Perform actions required as a consequence of deleting a series. Return true if something was done.

The method does not manage relationships or dependencies in the core system. Its responsibility is to call the relevant extension methods.

Parameters:

series - a series

Returns:

true is anything was done

Throws:

T2DBException

deleteValue

boolean deleteValue(UpdatableSeries<?> series,
                    ch.agent.t2.time.TimeIndex index)
             throws T2DBException

Perform actions required as a consequence of deleting a value. Return true if something was done.

The method does not manage relationships or dependencies in the core system. Its responsibility is to call the relevant extension methods.

Parameters:

series - a series

index - a time index

Returns:

true is anything was done

Throws:

T2DBException

update

boolean update(UpdatableSeries<?> series,
               ch.agent.t2.time.Range range)
        throws T2DBException

Perform actions required as a consequence of updating the range of a series. Return true if something was done.

The method does not manage relationships or dependencies in the core system. Its responsibility is to call the relevant extension methods.

Parameters:

series - a series

range - the new range

Returns:

true is anything was done

Throws:

T2DBException