Package de.hybris.platform.impex.model

Class ImpExMediaModel

    • Field Detail

      • _TYPECODE

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

      • FIELDSEPARATOR

        public static final java.lang.String FIELDSEPARATOR
        Generated constant - Attribute key of ImpExMedia.fieldSeparator attribute defined at extension impex.
        See Also:
        Constant Field Values

      • QUOTECHARACTER

        public static final java.lang.String QUOTECHARACTER
        Generated constant - Attribute key of ImpExMedia.quoteCharacter attribute defined at extension impex.
        See Also:
        Constant Field Values

      • COMMENTCHARACTER

        public static final java.lang.String COMMENTCHARACTER
        Generated constant - Attribute key of ImpExMedia.commentCharacter attribute defined at extension impex.
        See Also:
        Constant Field Values

      • ENCODING

        public static final java.lang.String ENCODING
        Generated constant - Attribute key of ImpExMedia.encoding attribute defined at extension impex.
        See Also:
        Constant Field Values

      • LINESTOSKIP

        public static final java.lang.String LINESTOSKIP
        Generated constant - Attribute key of ImpExMedia.linesToSkip attribute defined at extension impex.
        See Also:
        Constant Field Values

      • REMOVEONSUCCESS

        public static final java.lang.String REMOVEONSUCCESS
        Generated constant - Attribute key of ImpExMedia.removeOnSuccess attribute defined at extension impex.
        See Also:
        Constant Field Values

      • ZIPENTRY

        public static final java.lang.String ZIPENTRY
        Generated constant - Attribute key of ImpExMedia.zipentry attribute defined at extension impex.
        See Also:
        Constant Field Values

      • PREVIEW

        public static final java.lang.String PREVIEW
        Generated constant - Attribute key of ImpExMedia.preview attribute defined at extension impex.
        See Also:
        Constant Field Values

      • EXTRACTIONID

        public static final java.lang.String EXTRACTIONID
        Generated constant - Attribute key of ImpExMedia.extractionId attribute defined at extension impex.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ImpExMediaModel

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

      • ImpExMediaModel

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

      • ImpExMediaModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ImpExMediaModel​(CatalogVersionModel _catalogVersion,
                       java.lang.String _code,
                       int _linesToSkip,
                       boolean _removeOnSuccess)
        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 ImpExMedia at extension catalog
        _code - initial attribute declared by type Media at extension core
        _linesToSkip - initial attribute declared by type ImpExMedia at extension impex
        _removeOnSuccess - initial attribute declared by type ImpExMedia at extension impex

      • ImpExMediaModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ImpExMediaModel​(CatalogVersionModel _catalogVersion,
                       java.lang.String _code,
                       java.lang.String _extractionId,
                       int _linesToSkip,
                       ItemModel _owner,
                       boolean _removeOnSuccess)
        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 ImpExMedia at extension catalog
        _code - initial attribute declared by type Media at extension core
        _extractionId - initial attribute declared by type ImpExMedia at extension impex
        _linesToSkip - initial attribute declared by type ImpExMedia at extension impex
        _owner - initial attribute declared by type Item at extension core
        _removeOnSuccess - initial attribute declared by type ImpExMedia at extension impex

    • Method Detail

      • getCommentCharacter

        @Accessor(qualifier="commentCharacter",
          type=GETTER)
public java.lang.Character getCommentCharacter()
        Generated method - Getter of the ImpExMedia.commentCharacter attribute defined at extension impex.
        Returns:
        the commentCharacter - Character used for indicating a comment

      • getEncoding

        @Accessor(qualifier="encoding",
          type=GETTER)
public EncodingEnum getEncoding()
        Generated method - Getter of the ImpExMedia.encoding attribute defined at extension impex.
        Returns:
        the encoding - Used encoding for data stored within media

      • getExtractionId

        @Accessor(qualifier="extractionId",
          type=GETTER)
public java.lang.String getExtractionId()
        Generated method - Getter of the ImpExMedia.extractionId attribute defined at extension impex.
        Returns:
        the extractionId - Unique Id of zip extraction process

      • getFieldSeparator

        @Accessor(qualifier="fieldSeparator",
          type=GETTER)
public java.lang.Character getFieldSeparator()
        Generated method - Getter of the ImpExMedia.fieldSeparator attribute defined at extension impex.
        Returns:
        the fieldSeparator - Character used for separating columns in CSV-lines

      • getLinesToSkip

        @Accessor(qualifier="linesToSkip",
          type=GETTER)
public int getLinesToSkip()
        Generated method - Getter of the ImpExMedia.linesToSkip attribute defined at extension impex.
        Returns:
        the linesToSkip - Amount of lines ImpEx has to skip while processing data

      • getPreview

        @Accessor(qualifier="preview",
          type=GETTER)
public java.lang.String getPreview()
        Generated method - Getter of the ImpExMedia.preview attribute defined at extension impex.
        Returns:
        the preview - Preview of content

      • getQuoteCharacter

        @Accessor(qualifier="quoteCharacter",
          type=GETTER)
public java.lang.Character getQuoteCharacter()
        Generated method - Getter of the ImpExMedia.quoteCharacter attribute defined at extension impex.
        Returns:
        the quoteCharacter - Character used for escaping columns in CSV-lines

      • getZipentry

        @Accessor(qualifier="zipentry",
          type=GETTER)
public java.lang.String getZipentry()
        Generated method - Getter of the ImpExMedia.zipentry attribute defined at extension impex.
        Returns:
        the zipentry

      • isRemoveOnSuccess

        @Accessor(qualifier="removeOnSuccess",
          type=GETTER)
public boolean isRemoveOnSuccess()
        Generated method - Getter of the ImpExMedia.removeOnSuccess attribute defined at extension impex.
        Returns:
        the removeOnSuccess - Should the media be removed after processing?

      • setCommentCharacter

        @Accessor(qualifier="commentCharacter",
          type=SETTER)
public void setCommentCharacter​(java.lang.Character value)
        Generated method - Setter of ImpExMedia.commentCharacter attribute defined at extension impex.
        Parameters:
        value - the commentCharacter - Character used for indicating a comment

      • setEncoding

        @Accessor(qualifier="encoding",
          type=SETTER)
public void setEncoding​(EncodingEnum value)
        Generated method - Setter of ImpExMedia.encoding attribute defined at extension impex.
        Parameters:
        value - the encoding - Used encoding for data stored within media

      • setExtractionId

        @Accessor(qualifier="extractionId",
          type=SETTER)
public void setExtractionId​(java.lang.String value)
        Generated method - Initial setter of ImpExMedia.extractionId attribute defined at extension impex. Can only be used at creation of model - before first save.
        Parameters:
        value - the extractionId - Unique Id of zip extraction process

      • setFieldSeparator

        @Accessor(qualifier="fieldSeparator",
          type=SETTER)
public void setFieldSeparator​(java.lang.Character value)
        Generated method - Setter of ImpExMedia.fieldSeparator attribute defined at extension impex.
        Parameters:
        value - the fieldSeparator - Character used for separating columns in CSV-lines

      • setLinesToSkip

        @Accessor(qualifier="linesToSkip",
          type=SETTER)
public void setLinesToSkip​(int value)
        Generated method - Setter of ImpExMedia.linesToSkip attribute defined at extension impex.
        Parameters:
        value - the linesToSkip - Amount of lines ImpEx has to skip while processing data

      • setQuoteCharacter

        @Accessor(qualifier="quoteCharacter",
          type=SETTER)
public void setQuoteCharacter​(java.lang.Character value)
        Generated method - Setter of ImpExMedia.quoteCharacter attribute defined at extension impex.
        Parameters:
        value - the quoteCharacter - Character used for escaping columns in CSV-lines

      • setRemoveOnSuccess

        @Accessor(qualifier="removeOnSuccess",
          type=SETTER)
public void setRemoveOnSuccess​(boolean value)
        Generated method - Setter of ImpExMedia.removeOnSuccess attribute defined at extension impex.
        Parameters:
        value - the removeOnSuccess - Should the media be removed after processing?

      • setZipentry

        @Accessor(qualifier="zipentry",
          type=SETTER)
public void setZipentry​(java.lang.String value)
        Generated method - Setter of ImpExMedia.zipentry attribute defined at extension impex.
        Parameters:
        value - the zipentry