Package org.opencms.xml.content

Interface I_CmsXmlContentAugmentation

All Known Implementing Classes:
CmsAiContentTranslation.Augmentation, CmsJspContentAugmentation
public interface I_CmsXmlContentAugmentation
Interface for 'content augmentations' which can be used to augment the currently edited content.

This can effectively replace the complete content, but in

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    I_CmsXmlContentAugmentation.Context
    Context provided to the content augmentation class.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_CONTEXT
    The name of the request attribute used to pass the augmentation context to JSPs.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    augmentContent(I_CmsXmlContentAugmentation.Context context)
    Augments the content provided in the given context.

  • Field Details

  • Method Details

    • augmentContent

      void augmentContent(I_CmsXmlContentAugmentation.Context context) throws Exception
      Augments the content provided in the given context.

      Implementations can query the given context for information like the original XML content and the current locale, do some processing, and, in the end, call the setResult method to provide the finished, augmented content.

      Parameters:
      context - the augmentation context - provides access to the content and further information
      Throws:
      Exception - if something goes wrong