Package de.hybris.platform.commons.model

Class FormatModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class FormatModel
extends ItemModel
    Generated model class for type Format first defined at extension commons.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CHAINED
      Generated constant - Attribute key of Format.chained attribute defined at extension commons.
      static java.lang.String CODE
      Generated constant - Attribute key of Format.code attribute defined at extension commons.
      static java.lang.String DOCUMENTTYPE
      Generated constant - Attribute key of Format.documentType attribute defined at extension commons.
      static java.lang.String INITIAL
      Generated constant - Attribute key of Format.initial attribute defined at extension commons.
      static java.lang.String NAME
      Generated constant - Attribute key of Format.name attribute defined at extension commons.
      static java.lang.String VALIDFOR
      Generated constant - Attribute key of Format.validFor attribute defined at extension commons.

      • Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      FormatModel()
      Generated constructor - Default constructor for generic creation.
      FormatModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      FormatModel​(java.lang.String _code, DocumentTypeEnum _documentType, ItemFormatterModel _initial)
      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
      FormatModel​(java.lang.String _code, DocumentTypeEnum _documentType, ItemFormatterModel _initial, ItemModel _owner)
      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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Collection<MediaFormatterModel> getChained()
      Generated method - Getter of the Format.chained attribute defined at extension commons.
      java.lang.String getCode()
      Generated method - Getter of the Format.code attribute defined at extension commons.
      DocumentTypeEnum getDocumentType()
      Generated method - Getter of the Format.documentType attribute defined at extension commons.
      ItemFormatterModel getInitial()
      Generated method - Getter of the Format.initial attribute defined at extension commons.
      java.lang.String getName()
      Generated method - Getter of the Format.name attribute defined at extension commons.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the Format.name attribute defined at extension commons.
      java.util.Collection<ComposedTypeModel> getValidFor()
      Generated method - Getter of the Format.validFor attribute defined at extension commons.
      void setChained​(java.util.Collection<MediaFormatterModel> value)
      Generated method - Setter of Format.chained attribute defined at extension commons.
      void setCode​(java.lang.String value)
      Generated method - Initial setter of Format.code attribute defined at extension commons.
      void setDocumentType​(DocumentTypeEnum value)
      Generated method - Setter of Format.documentType attribute defined at extension commons.
      void setInitial​(ItemFormatterModel value)
      Generated method - Setter of Format.initial attribute defined at extension commons.
      void setName​(java.lang.String value)
      Generated method - Setter of Format.name attribute defined at extension commons.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of Format.name attribute defined at extension commons.
      void setValidFor​(java.util.Collection<ComposedTypeModel> value)
      Generated method - Setter of Format.validFor attribute defined at extension commons.

      • Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • 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 Format.code attribute defined at extension commons.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of Format.name attribute defined at extension commons.
        See Also:
        Constant Field Values

      • INITIAL

        public static final java.lang.String INITIAL
        Generated constant - Attribute key of Format.initial attribute defined at extension commons.
        See Also:
        Constant Field Values

      • DOCUMENTTYPE

        public static final java.lang.String DOCUMENTTYPE
        Generated constant - Attribute key of Format.documentType attribute defined at extension commons.
        See Also:
        Constant Field Values

      • CHAINED

        public static final java.lang.String CHAINED
        Generated constant - Attribute key of Format.chained attribute defined at extension commons.
        See Also:
        Constant Field Values

      • VALIDFOR

        public static final java.lang.String VALIDFOR
        Generated constant - Attribute key of Format.validFor attribute defined at extension commons.
        See Also:
        Constant Field Values

    • Constructor Detail

      • FormatModel

        public FormatModel()
        Generated constructor - Default constructor for generic creation.

      • FormatModel

        public FormatModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • FormatModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public FormatModel​(java.lang.String _code,
                   DocumentTypeEnum _documentType,
                   ItemFormatterModel _initial)
        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 Format at extension commons
        _documentType - initial attribute declared by type Format at extension commons
        _initial - initial attribute declared by type Format at extension commons

      • FormatModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public FormatModel​(java.lang.String _code,
                   DocumentTypeEnum _documentType,
                   ItemFormatterModel _initial,
                   ItemModel _owner)
        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 Format at extension commons
        _documentType - initial attribute declared by type Format at extension commons
        _initial - initial attribute declared by type Format at extension commons
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getChained

        @Accessor(qualifier="chained",
          type=GETTER)
public java.util.Collection<MediaFormatterModel> getChained()
        Generated method - Getter of the Format.chained attribute defined at extension commons. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the chained

      • getCode

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

      • getDocumentType

        @Accessor(qualifier="documentType",
          type=GETTER)
public DocumentTypeEnum getDocumentType()
        Generated method - Getter of the Format.documentType attribute defined at extension commons.
        Returns:
        the documentType

      • getInitial

        @Accessor(qualifier="initial",
          type=GETTER)
public ItemFormatterModel getInitial()
        Generated method - Getter of the Format.initial attribute defined at extension commons.
        Returns:
        the initial

      • getName

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

      • getName

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

      • getValidFor

        @Accessor(qualifier="validFor",
          type=GETTER)
public java.util.Collection<ComposedTypeModel> getValidFor()
        Generated method - Getter of the Format.validFor attribute defined at extension commons. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the validFor

      • setChained

        @Accessor(qualifier="chained",
          type=SETTER)
public void setChained​(java.util.Collection<MediaFormatterModel> value)
        Generated method - Setter of Format.chained attribute defined at extension commons.
        Parameters:
        value - the chained

      • setCode

        @Accessor(qualifier="code",
          type=SETTER)
public void setCode​(java.lang.String value)
        Generated method - Initial setter of Format.code attribute defined at extension commons. Can only be used at creation of model - before first save.
        Parameters:
        value - the code

      • setDocumentType

        @Accessor(qualifier="documentType",
          type=SETTER)
public void setDocumentType​(DocumentTypeEnum value)
        Generated method - Setter of Format.documentType attribute defined at extension commons.
        Parameters:
        value - the documentType

      • setInitial

        @Accessor(qualifier="initial",
          type=SETTER)
public void setInitial​(ItemFormatterModel value)
        Generated method - Setter of Format.initial attribute defined at extension commons.
        Parameters:
        value - the initial

      • setName

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

      • setName

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

      • setValidFor

        @Accessor(qualifier="validFor",
          type=SETTER)
public void setValidFor​(java.util.Collection<ComposedTypeModel> value)
        Generated method - Setter of Format.validFor attribute defined at extension commons.
        Parameters:
        value - the validFor