Class RendererTemplateModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    AuditReportTemplateModel

    public class RendererTemplateModel
    extends ItemModel
    Generated model class for type RendererTemplate first defined at extension commons.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CODE
      Generated constant - Attribute key of RendererTemplate.code attribute defined at extension commons.
      static java.lang.String CONTENT
      Generated constant - Attribute key of RendererTemplate.content attribute defined at extension commons.
      static java.lang.String CONTEXTCLASS
      Generated constant - Attribute key of RendererTemplate.contextClass attribute defined at extension commons.
      static java.lang.String CONTEXTCLASSDESCRIPTION
      Generated constant - Attribute key of RendererTemplate.contextClassDescription attribute defined at extension commons.
      static java.lang.String DEFAULTCONTENT
      Generated constant - Attribute key of RendererTemplate.defaultContent attribute defined at extension commons.
      static java.lang.String DEFAULTTEMPLATESCRIPT
      Generated constant - Attribute key of RendererTemplate.defaultTemplateScript attribute defined at extension commons.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of RendererTemplate.description attribute defined at extension commons.
      static java.lang.String OUTPUTMIMETYPE
      Generated constant - Attribute key of RendererTemplate.outputMimeType attribute defined at extension commons.
      static java.lang.String RENDERERTYPE
      Generated constant - Attribute key of RendererTemplate.rendererType attribute defined at extension commons.
      static java.lang.String TEMPLATESCRIPT
      Generated constant - Attribute key of RendererTemplate.templateScript attribute defined at extension commons.
    • Constructor Summary

      Constructors 
      Constructor Description
      RendererTemplateModel()
      Generated constructor - Default constructor for generic creation.
      RendererTemplateModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      RendererTemplateModel​(java.lang.String _code, RendererTypeEnum _rendererType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      RendererTemplateModel​(java.lang.String _code, ItemModel _owner, RendererTypeEnum _rendererType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • CODE

        public static final java.lang.String CODE
        Generated constant - Attribute key of RendererTemplate.code attribute defined at extension commons.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of RendererTemplate.description attribute defined at extension commons.
        See Also:
        Constant Field Values
      • DEFAULTCONTENT

        public static final java.lang.String DEFAULTCONTENT
        Generated constant - Attribute key of RendererTemplate.defaultContent attribute defined at extension commons.
        See Also:
        Constant Field Values
      • CONTENT

        public static final java.lang.String CONTENT
        Generated constant - Attribute key of RendererTemplate.content attribute defined at extension commons.
        See Also:
        Constant Field Values
      • CONTEXTCLASS

        public static final java.lang.String CONTEXTCLASS
        Generated constant - Attribute key of RendererTemplate.contextClass attribute defined at extension commons.
        See Also:
        Constant Field Values
      • OUTPUTMIMETYPE

        public static final java.lang.String OUTPUTMIMETYPE
        Generated constant - Attribute key of RendererTemplate.outputMimeType attribute defined at extension commons.
        See Also:
        Constant Field Values
      • RENDERERTYPE

        public static final java.lang.String RENDERERTYPE
        Generated constant - Attribute key of RendererTemplate.rendererType attribute defined at extension commons.
        See Also:
        Constant Field Values
      • DEFAULTTEMPLATESCRIPT

        public static final java.lang.String DEFAULTTEMPLATESCRIPT
        Generated constant - Attribute key of RendererTemplate.defaultTemplateScript attribute defined at extension commons.
        See Also:
        Constant Field Values
      • TEMPLATESCRIPT

        public static final java.lang.String TEMPLATESCRIPT
        Generated constant - Attribute key of RendererTemplate.templateScript attribute defined at extension commons.
        See Also:
        Constant Field Values
      • CONTEXTCLASSDESCRIPTION

        public static final java.lang.String CONTEXTCLASSDESCRIPTION
        Generated constant - Attribute key of RendererTemplate.contextClassDescription attribute defined at extension commons.
        See Also:
        Constant Field Values
    • Constructor Detail

      • RendererTemplateModel

        public RendererTemplateModel()
        Generated constructor - Default constructor for generic creation.
      • RendererTemplateModel

        public RendererTemplateModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • RendererTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public RendererTemplateModel​(java.lang.String _code,
                                     RendererTypeEnum _rendererType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _code - initial attribute declared by type RendererTemplate at extension commons
        _rendererType - initial attribute declared by type RendererTemplate at extension commons
      • RendererTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public RendererTemplateModel​(java.lang.String _code,
                                     ItemModel _owner,
                                     RendererTypeEnum _rendererType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _code - initial attribute declared by type RendererTemplate at extension commons
        _owner - initial attribute declared by type Item at extension core
        _rendererType - initial attribute declared by type RendererTemplate at extension commons
    • Method Detail

      • getCode

        @Accessor(qualifier="code",
                  type=GETTER)
        public java.lang.String getCode()
        Generated method - Getter of the RendererTemplate.code attribute defined at extension commons.
        Returns:
        the code - unique item identifier
      • getContent

        @Accessor(qualifier="content",
                  type=GETTER)
        public MediaModel getContent()
        Generated method - Getter of the RendererTemplate.content attribute defined at extension commons.
        Returns:
        the content
      • getContent

        @Accessor(qualifier="content",
                  type=GETTER)
        public MediaModel getContent​(java.util.Locale loc)
        Generated method - Getter of the RendererTemplate.content attribute defined at extension commons.
        Parameters:
        loc - the value localization key
        Returns:
        the content
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getContextClass

        @Accessor(qualifier="contextClass",
                  type=GETTER)
        public java.lang.String getContextClass()
        Generated method - Getter of the RendererTemplate.contextClass attribute defined at extension commons.
        Returns:
        the contextClass
      • getContextClassDescription

        @Accessor(qualifier="contextClassDescription",
                  type=GETTER)
        public java.lang.String getContextClassDescription()
        Generated method - Getter of the RendererTemplate.contextClassDescription attribute defined at extension commons.
        Returns:
        the contextClassDescription
      • getDefaultContent

        @Accessor(qualifier="defaultContent",
                  type=GETTER)
        public MediaModel getDefaultContent()
        Generated method - Getter of the RendererTemplate.defaultContent attribute defined at extension commons.
        Returns:
        the defaultContent
      • getDefaultTemplateScript

        @Accessor(qualifier="defaultTemplateScript",
                  type=GETTER)
        public java.lang.String getDefaultTemplateScript()
        Generated method - Getter of the RendererTemplate.defaultTemplateScript dynamic attribute defined at extension commons.
        Returns:
        the defaultTemplateScript
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the RendererTemplate.description attribute defined at extension commons.
        Returns:
        the description
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the RendererTemplate.description attribute defined at extension commons.
        Parameters:
        loc - the value localization key
        Returns:
        the description
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getOutputMimeType

        @Accessor(qualifier="outputMimeType",
                  type=GETTER)
        public java.lang.String getOutputMimeType()
        Generated method - Getter of the RendererTemplate.outputMimeType attribute defined at extension commons.
        Returns:
        the outputMimeType
      • getRendererType

        @Accessor(qualifier="rendererType",
                  type=GETTER)
        public RendererTypeEnum getRendererType()
        Generated method - Getter of the RendererTemplate.rendererType attribute defined at extension commons.
        Returns:
        the rendererType
      • getTemplateScript

        @Accessor(qualifier="templateScript",
                  type=GETTER)
        public java.lang.String getTemplateScript()
        Generated method - Getter of the RendererTemplate.templateScript attribute defined at extension commons.
        Returns:
        the templateScript
      • getTemplateScript

        @Accessor(qualifier="templateScript",
                  type=GETTER)
        public java.lang.String getTemplateScript​(java.util.Locale loc)
        Generated method - Getter of the RendererTemplate.templateScript attribute defined at extension commons.
        Parameters:
        loc - the value localization key
        Returns:
        the templateScript
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setCode

        @Accessor(qualifier="code",
                  type=SETTER)
        public void setCode​(java.lang.String value)
        Generated method - Setter of RendererTemplate.code attribute defined at extension commons.
        Parameters:
        value - the code - unique item identifier
      • setContent

        @Accessor(qualifier="content",
                  type=SETTER)
        public void setContent​(MediaModel value)
        Generated method - Setter of RendererTemplate.content attribute defined at extension commons.
        Parameters:
        value - the content
      • setContent

        @Accessor(qualifier="content",
                  type=SETTER)
        public void setContent​(MediaModel value,
                               java.util.Locale loc)
        Generated method - Setter of RendererTemplate.content attribute defined at extension commons.
        Parameters:
        value - the content
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setContextClass

        @Accessor(qualifier="contextClass",
                  type=SETTER)
        public void setContextClass​(java.lang.String value)
        Generated method - Setter of RendererTemplate.contextClass attribute defined at extension commons.
        Parameters:
        value - the contextClass
      • setDefaultContent

        @Accessor(qualifier="defaultContent",
                  type=SETTER)
        public void setDefaultContent​(MediaModel value)
        Generated method - Setter of RendererTemplate.defaultContent attribute defined at extension commons.
        Parameters:
        value - the defaultContent
      • setDefaultTemplateScript

        @Accessor(qualifier="defaultTemplateScript",
                  type=SETTER)
        public void setDefaultTemplateScript​(java.lang.String value)
        Generated method - Setter of RendererTemplate.defaultTemplateScript dynamic attribute defined at extension commons.
        Parameters:
        value - the defaultTemplateScript
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of RendererTemplate.description attribute defined at extension commons.
        Parameters:
        value - the description
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value,
                                   java.util.Locale loc)
        Generated method - Setter of RendererTemplate.description attribute defined at extension commons.
        Parameters:
        value - the description
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setOutputMimeType

        @Accessor(qualifier="outputMimeType",
                  type=SETTER)
        public void setOutputMimeType​(java.lang.String value)
        Generated method - Setter of RendererTemplate.outputMimeType attribute defined at extension commons.
        Parameters:
        value - the outputMimeType
      • setRendererType

        @Accessor(qualifier="rendererType",
                  type=SETTER)
        public void setRendererType​(RendererTypeEnum value)
        Generated method - Setter of RendererTemplate.rendererType attribute defined at extension commons.
        Parameters:
        value - the rendererType
      • setTemplateScript

        @Accessor(qualifier="templateScript",
                  type=SETTER)
        public void setTemplateScript​(java.lang.String value)
        Generated method - Setter of RendererTemplate.templateScript attribute defined at extension commons.
        Parameters:
        value - the templateScript
      • setTemplateScript

        @Accessor(qualifier="templateScript",
                  type=SETTER)
        public void setTemplateScript​(java.lang.String value,
                                      java.util.Locale loc)
        Generated method - Setter of RendererTemplate.templateScript attribute defined at extension commons.
        Parameters:
        value - the templateScript
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language