Package de.hybris.platform.impex.model

Class ImpExMediaModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.core.model.media.AbstractMediaModel

de.hybris.platform.core.model.media.MediaModel

de.hybris.platform.impex.model.ImpExMediaModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HeaderLibraryModel, ImpExExportMediaModel

public class ImpExMediaModel
extends MediaModel

Generated model class for type ImpExMedia first defined at extension impex.

See Also:

• Serialized Form

Nested Class Summary

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

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_TYPECODE	Generated model type code constant.
static final String	COMMENTCHARACTER	Generated constant - Attribute key of ImpExMedia.commentCharacter attribute defined at extension impex.
static final String	ENCODING	Generated constant - Attribute key of ImpExMedia.encoding attribute defined at extension impex.
static final String	EXTRACTIONID	Generated constant - Attribute key of ImpExMedia.extractionId attribute defined at extension impex.
static final String	FIELDSEPARATOR	Generated constant - Attribute key of ImpExMedia.fieldSeparator attribute defined at extension impex.
static final String	LINESTOSKIP	Generated constant - Attribute key of ImpExMedia.linesToSkip attribute defined at extension impex.
static final String	PREVIEW	Generated constant - Attribute key of ImpExMedia.preview attribute defined at extension impex.
static final String	QUOTECHARACTER	Generated constant - Attribute key of ImpExMedia.quoteCharacter attribute defined at extension impex.
static final String	REMOVEONSUCCESS	Generated constant - Attribute key of ImpExMedia.removeOnSuccess attribute defined at extension impex.
static final String	ZIPENTRY	Generated constant - Attribute key of ImpExMedia.zipentry attribute defined at extension impex.

Fields inherited from class de.hybris.platform.core.model.media.MediaModel

_CATEGORYMEDIARELATION, _CONVERTEDMEDIASRELATION, _MEDIACONTAINER2MEDIAREL, ALTTEXT, CATALOG, CATALOGVERSION, CODE, CONVERTEDMEDIAS, DENIEDPRINCIPALS, DERIVEDMEDIAS, DESCRIPTION, DOWNLOADURL, FOLDER, FOREIGNDATAOWNERS, INTERNALURL, MEDIACONTAINER, MEDIAFORMAT, METADATA, METADATADATAPK, ORIGINAL, ORIGINALDATAPK, PERMITTEDPRINCIPALS, REMOVABLE, SUBFOLDERPATH, SUPERCATEGORIES, URL, URL2

Fields inherited from class de.hybris.platform.core.model.media.AbstractMediaModel

DATAPK, LOCATION, LOCATIONHASH, MIME, REALFILENAME, SIZE

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

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

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor	Description
ImpExMediaModel()	Generated constructor - Default constructor for generic creation.
ImpExMediaModel(CatalogVersionModel _catalogVersion, 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
ImpExMediaModel(CatalogVersionModel _catalogVersion, String _code, 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
ImpExMediaModel(ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
Character	getCommentCharacter()	Generated method - Getter of the ImpExMedia.commentCharacter attribute defined at extension impex.
EncodingEnum	getEncoding()	Generated method - Getter of the ImpExMedia.encoding attribute defined at extension impex.
String	getExtractionId()	Generated method - Getter of the ImpExMedia.extractionId attribute defined at extension impex.
Character	getFieldSeparator()	Generated method - Getter of the ImpExMedia.fieldSeparator attribute defined at extension impex.
int	getLinesToSkip()	Generated method - Getter of the ImpExMedia.linesToSkip attribute defined at extension impex.
String	getPreview()	Generated method - Getter of the ImpExMedia.preview attribute defined at extension impex.
Character	getQuoteCharacter()	Generated method - Getter of the ImpExMedia.quoteCharacter attribute defined at extension impex.
String	getZipentry()	Generated method - Getter of the ImpExMedia.zipentry attribute defined at extension impex.
boolean	isRemoveOnSuccess()	Generated method - Getter of the ImpExMedia.removeOnSuccess attribute defined at extension impex.
void	setCommentCharacter(Character value)	Generated method - Setter of ImpExMedia.commentCharacter attribute defined at extension impex.
void	setEncoding(EncodingEnum value)	Generated method - Setter of ImpExMedia.encoding attribute defined at extension impex.
void	setExtractionId(String value)	Generated method - Initial setter of ImpExMedia.extractionId attribute defined at extension impex.
void	setFieldSeparator(Character value)	Generated method - Setter of ImpExMedia.fieldSeparator attribute defined at extension impex.
void	setLinesToSkip(int value)	Generated method - Setter of ImpExMedia.linesToSkip attribute defined at extension impex.
void	setQuoteCharacter(Character value)	Generated method - Setter of ImpExMedia.quoteCharacter attribute defined at extension impex.
void	setRemoveOnSuccess(boolean value)	Generated method - Setter of ImpExMedia.removeOnSuccess attribute defined at extension impex.
void	setZipentry(String value)	Generated method - Setter of ImpExMedia.zipentry attribute defined at extension impex.

Methods inherited from class de.hybris.platform.core.model.media.MediaModel

getAlttext, getAltText, getCatalogVersion, getCode, getConvertedMedias, getDeniedPrincipals, getDerivedMedias, getDescription, getDownloadurl, getDownloadURL, getFolder, getForeignDataOwners, getInternalURL, getMediaContainer, getMediaFormat, getMetaData, getMetaDataDataPK, getOriginal, getOriginalDataPK, getPermittedPrincipals, getRemovable, getSubFolderPath, getSupercategories, getUrl, getURL, getUrl2, getURL2, setAlttext, setAltText, setCatalogVersion, setCode, setConvertedMedias, setDeniedPrincipals, setDerivedMedias, setDescription, setFolder, setInternalURL, setMediaContainer, setMediaFormat, setMetaData, setMetaDataDataPK, setOriginal, setOriginalDataPK, setPermittedPrincipals, setRemovable, setSubFolderPath, setSupercategories, setUrl, setURL

Methods inherited from class de.hybris.platform.core.model.media.AbstractMediaModel

getDataPK, getLocation, getLocationHash, getMime, getRealfilename, getRealFileName, getSize, setDataPK, setLocation, setLocationHash, setMime, setRealfilename, setRealFileName, setSize

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

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 Details

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

• Constant Field Values

FIELDSEPARATOR

public static final String FIELDSEPARATOR

Generated constant - Attribute key of ImpExMedia.fieldSeparator attribute defined at extension impex.

See Also:

• Constant Field Values

QUOTECHARACTER

public static final String QUOTECHARACTER

Generated constant - Attribute key of ImpExMedia.quoteCharacter attribute defined at extension impex.

See Also:

• Constant Field Values

COMMENTCHARACTER

public static final String COMMENTCHARACTER

Generated constant - Attribute key of ImpExMedia.commentCharacter attribute defined at extension impex.

See Also:

• Constant Field Values

ENCODING

public static final String ENCODING

Generated constant - Attribute key of ImpExMedia.encoding attribute defined at extension impex.

See Also:

• Constant Field Values

LINESTOSKIP

public static final String LINESTOSKIP

Generated constant - Attribute key of ImpExMedia.linesToSkip attribute defined at extension impex.

See Also:

• Constant Field Values

REMOVEONSUCCESS

public static final String REMOVEONSUCCESS

Generated constant - Attribute key of ImpExMedia.removeOnSuccess attribute defined at extension impex.

See Also:

• Constant Field Values

ZIPENTRY

public static final String ZIPENTRY

Generated constant - Attribute key of ImpExMedia.zipentry attribute defined at extension impex.

See Also:

• Constant Field Values

PREVIEW

public static final String PREVIEW

Generated constant - Attribute key of ImpExMedia.preview attribute defined at extension impex.

See Also:

• Constant Field Values

EXTRACTIONID

public static final String EXTRACTIONID

Generated constant - Attribute key of ImpExMedia.extractionId attribute defined at extension impex.

See Also:

• Constant Field Values

Constructor Details

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,
 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,
 String _code,
 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 Details

getCommentCharacter

@Accessor(qualifier="commentCharacter",
          type=GETTER)
public 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 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 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 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 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 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(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(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(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(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(String value)

Generated method - Setter of ImpExMedia.zipentry attribute defined at extension impex.

Parameters:

value - the zipentry