com.jalios.jstore
Interface StoreListener

All Known Implementing Classes:
AbstractFileIndexListener, AbstractLinkIndexListener, AudienceRights, BasicDBListenerStoreListener, BasicStoreListener, CacheManager, CategoryListener, CategorySearchEngineListener, DataListener, DescriptiveURLs.DescriptiveURLsListener, FileDocumentListener, FileProcessorDBListenerStoreListener, GroupListener, ImportDataListener, JSyncDataListener, MemberListener, MemberSearchEngineListener, PublicationListener, PublicationSearchEngineListener, StatReportListener, SyncManager, WeakLinkManager, WFPublicationListener, WKRoleListener, WorkspaceListener, WSTypeEntryListener

public interface StoreListener

A Store event gets fired whenever a storable is created, updated or deleted. You can register a StoreListener so as to be notified of any store updates.

Version:
$Revision: 21412 $
Author:
Olivier Dedieu

Field Summary
static String REVISION
           
 
Method Summary
 void handleCommitUpdate(Storable storable, Storable oldStorable, boolean firstTime)
          This method gets called when after a storable has been updated.
 void handleCreate(Storable storable, boolean firstTime)
          This method gets called when a storable is created.
 void handleDelete(Storable storable, boolean firstTime)
          This method gets called when a storable is deleted.
 void handlePrepareUpdate(Storable storable, Map<String,String> attributes, boolean firstTime)
          This method gets called when before a storable will be updated.
 

Field Detail

REVISION

static final String REVISION
See Also:
Constant Field Values
Method Detail

handleCreate

void handleCreate(Storable storable,
                  boolean firstTime)
This method gets called when a storable is created.

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

handlePrepareUpdate

void handlePrepareUpdate(Storable storable,
                         Map<String,String> attributes,
                         boolean firstTime)
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.

Parameters:
storable - the storable
attributes - the attributes to update
firstTime - true if it is the first time this operation is processed

handleCommitUpdate

void handleCommitUpdate(Storable storable,
                        Storable oldStorable,
                        boolean firstTime)
This method gets called when after a storable has been updated.

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

handleDelete

void handleDelete(Storable storable,
                  boolean firstTime)
This method gets called when a storable is deleted.

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


Copyright © 2001-2010 Jalios SA. All Rights Reserved.