Class BasicStoreListener

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String REVISION  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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, java.util.Map attributes, boolean firstTime)
      This method gets called when before a storable will be updated.
      boolean init​(Plugin plugin)
      Initialize the component with the given plugin configuration
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BasicStoreListener

        public BasicStoreListener()
    • Method Detail

      • init

        public boolean init​(Plugin plugin)
        Description copied from interface: PluginComponent
        Initialize the component with the given plugin configuration
        Specified by:
        init in interface PluginComponent
        Parameters:
        plugin - the calling plugin
        Returns:
        true if the component has been correctly initialized.
        Since:
        jcms-5.7.1
        See Also:
        PluginComponent.init(Plugin)
      • handlePrepareUpdate

        public void handlePrepareUpdate​(Storable storable,
                                        java.util.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
        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
        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)