com.jalios.jcms
Class FileDocumentListener

java.lang.Object
  com.jalios.jcms.BasicStoreListener
      com.jalios.jcms.FileDocumentListener

All Implemented Interfaces:

PluginComponent, StoreListener

public class FileDocumentListener
extends BasicStoreListener

This class listens to mutation of FileDocument objects.

Since:

jcms-5.0.0

Version:

$Revision: 24966 $

Author:

Olivier Dedieu

Field Summary

static String

REVISION

Constructor Summary

FileDocumentListener()

Method Summary

void	handleCommitUpdate(Storable storable, Storable oldStorable, boolean firstTime) This method gets called when after a storable has been updated.
void	handleDelete(Storable storable, boolean firstTime) This method gets called when a storable is deleted.
void	handlePrepareUpdate(Storable storable, Map attributes, boolean firstTime) This method gets called when before a storable will be updated.

Methods inherited from class com.jalios.jcms.BasicStoreListener

handleCreate, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

FileDocumentListener

public FileDocumentListener()

Method Detail

handlePrepareUpdate

public void handlePrepareUpdate(Storable storable,
                                Map attributes,
                                boolean firstTime)

Description copied from interface: StoreListener

This method gets called when before a storable will be updated.
deprecated It should not be used anymore and will be removed from future version.

Specified by:

handlePrepareUpdate in interface StoreListener

Overrides:

handlePrepareUpdate in class BasicStoreListener

Parameters:

storable - the storable

attributes - the attributes to update

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handlePrepareUpdate(Storable, Map, boolean)

handleCommitUpdate

public void handleCommitUpdate(Storable storable,
                               Storable oldStorable,
                               boolean firstTime)

Description copied from interface: StoreListener

This method gets called when after a storable has been updated.

Specified by:

handleCommitUpdate in interface StoreListener

Overrides:

handleCommitUpdate in class BasicStoreListener

Parameters:

storable - the storable, this instance is the object that was created at first and that will be stored in jcms until deletion of the storable with this ID. You should always manipulate this object if you maintain any index.

oldStorable - the previous version of the storable, it is a clone, do not use in any index, it should only be used to access old values.

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handleCommitUpdate(Storable, Storable, boolean)

handleDelete

public void handleDelete(Storable storable,
                         boolean firstTime)

Description copied from interface: StoreListener

This method gets called when a storable is deleted.

Specified by:

handleDelete in interface StoreListener

Overrides:

handleDelete in class BasicStoreListener

Parameters:

storable - the storable

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handleDelete(Storable, boolean)