Package de.hybris.platform.commons.model

Class DocumentModel

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

    • Field Detail

      • _TYPECODE

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

      • _ITEMDOCRRELATION

        public static final java.lang.String _ITEMDOCRRELATION
        Generated relation code constant for relation ItemDocrRelation defining source attribute sourceItem in extension commons.
        See Also:
        Constant Field Values

      • ITEMTIMESTAMP

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

      • FORMAT

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

      • SOURCEITEM

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

    • Constructor Detail

      • DocumentModel

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

      • DocumentModel

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

      • DocumentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public DocumentModel​(CatalogVersionModel _catalogVersion,
                     java.lang.String _code,
                     FormatModel _format)
        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:
        _catalogVersion - initial attribute declared by type Document at extension catalog
        _code - initial attribute declared by type Media at extension core
        _format - initial attribute declared by type Document at extension commons

      • DocumentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public DocumentModel​(CatalogVersionModel _catalogVersion,
                     java.lang.String _code,
                     FormatModel _format,
                     ItemModel _owner,
                     ItemModel _sourceItem)
        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:
        _catalogVersion - initial attribute declared by type Document at extension catalog
        _code - initial attribute declared by type Media at extension core
        _format - initial attribute declared by type Document at extension commons
        _owner - initial attribute declared by type Item at extension core
        _sourceItem - initial attribute declared by type Document at extension commons

    • Method Detail

      • getFormat

        @Accessor(qualifier="format",
          type=GETTER)
public FormatModel getFormat()
        Generated method - Getter of the Document.format attribute defined at extension commons.
        Returns:
        the format - The format of the document

      • getItemTimestamp

        @Accessor(qualifier="itemTimestamp",
          type=GETTER)
public java.util.Date getItemTimestamp()
        Generated method - Getter of the Document.itemTimestamp attribute defined at extension commons.
        Returns:
        the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • getSourceItem

        @Accessor(qualifier="sourceItem",
          type=GETTER)
public ItemModel getSourceItem()
        Generated method - Getter of the Document.sourceItem attribute defined at extension commons.
        Returns:
        the sourceItem

      • setFormat

        @Accessor(qualifier="format",
          type=SETTER)
public void setFormat​(FormatModel value)
        Generated method - Initial setter of Document.format attribute defined at extension commons. Can only be used at creation of model - before first save.
        Parameters:
        value - the format - The format of the document

      • setItemTimestamp

        @Accessor(qualifier="itemTimestamp",
          type=SETTER)
public void setItemTimestamp​(java.util.Date value)
        Generated method - Setter of Document.itemTimestamp attribute defined at extension commons.
        Parameters:
        value - the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • setSourceItem

        @Accessor(qualifier="sourceItem",
          type=SETTER)
public void setSourceItem​(ItemModel value)
        Generated method - Initial setter of Document.sourceItem attribute defined at extension commons. Can only be used at creation of model - before first save.
        Parameters:
        value - the sourceItem