Package org.opencms.file.collectors

Interface I_CmsCollectorPostCreateHandler

All Known Implementing Classes:
CmsAddCategoriesPostCreateHandler, CmsDefaultPostCreateHandler
public interface I_CmsCollectorPostCreateHandler
Interface which can be used to add custom code to execute after a user has created a new content via a collector list.

Post create handlers can also be specified when using the tags CmsJspTagDisplay or CmsJspTagEdit.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
    This is called after the new content has been created (and possibly already been filled with content).
    default void
    onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, String config)
    This is called after the new content has been created (and possibly already been filled with content).
    static CmsPair<String,String>
    splitClassAndConfig(String handlerConfig)
    Splits the string that configures the handler into the handler class and the configuration part.

  • Method Details

    • splitClassAndConfig

      static CmsPair<String,String> splitClassAndConfig(String handlerConfig)
      Splits the string that configures the handler into the handler class and the configuration part.
      Parameters:
      handlerConfig - string that configures the handler
      Returns:
      pair with the handler class and the configuration

    • onCreate

      void onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
      This is called after the new content has been created (and possibly already been filled with content).

      Parameters:
      cms - the current user's CMS context
      createdResource - the resource which has been created
      copyMode - true if the user chose one of the elements in the collector list as a model

    • onCreate

      default void onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, String config)
      This is called after the new content has been created (and possibly already been filled with content).

      Parameters:
      cms - the current user's CMS context
      createdResource - the resource which has been created
      copyMode - true if the user chose one of the elements in the collector list as a model
      config - an optional configuration string that can be handled specific by each implementation