Package de.hybris.platform.commons.model

Class DocumentModel

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.commons.model.DocumentModel

All Implemented Interfaces:

Serializable

public class DocumentModel
extends MediaModel

Generated model class for type Document 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 final String	_ITEMDOCRRELATION	Generated relation code constant for relation ItemDocrRelation defining source attribute sourceItem in extension commons.
static final String	_TYPECODE	Generated model type code constant.
static final String	FORMAT	Generated constant - Attribute key of Document.format attribute defined at extension commons.
static final String	ITEMTIMESTAMP	Generated constant - Attribute key of Document.itemTimestamp attribute defined at extension commons.
static final String	SOURCEITEM	Generated constant - Attribute key of Document.sourceItem attribute defined at extension commons.

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

_CATEGORYMEDIARELATION, _MEDIACONTAINER2MEDIAREL, ALTTEXT, CATALOG, CATALOGVERSION, CODE, DENIEDPRINCIPALS, DERIVEDMEDIAS, DESCRIPTION, DOWNLOADURL, FOLDER, FOREIGNDATAOWNERS, INTERNALURL, MEDIACONTAINER, MEDIAFORMAT, 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
DocumentModel()	Generated constructor - Default constructor for generic creation.
DocumentModel(CatalogVersionModel _catalogVersion, 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
DocumentModel(CatalogVersionModel _catalogVersion, 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
DocumentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
FormatModel	getFormat()	Generated method - Getter of the Document.format attribute defined at extension commons.
Date	getItemTimestamp()	Generated method - Getter of the Document.itemTimestamp attribute defined at extension commons.
ItemModel	getSourceItem()	Generated method - Getter of the Document.sourceItem attribute defined at extension commons.
void	setFormat(FormatModel value)	Generated method - Initial setter of Document.format attribute defined at extension commons.
void	setItemTimestamp(Date value)	Generated method - Setter of Document.itemTimestamp attribute defined at extension commons.
void	setSourceItem(ItemModel value)	Generated method - Initial setter of Document.sourceItem attribute defined at extension commons.

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

getAlttext, getAltText, getCatalogVersion, getCode, getDeniedPrincipals, getDerivedMedias, getDescription, getDownloadurl, getDownloadURL, getFolder, getForeignDataOwners, getInternalURL, getMediaContainer, getMediaFormat, getPermittedPrincipals, getRemovable, getSubFolderPath, getSupercategories, getUrl, getURL, getUrl2, getURL2, setAlttext, setAltText, setCatalogVersion, setCode, setDeniedPrincipals, setDerivedMedias, setDescription, setFolder, setInternalURL, setMediaContainer, setMediaFormat, 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

_ITEMDOCRRELATION

public static final 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 String ITEMTIMESTAMP

Generated constant - Attribute key of Document.itemTimestamp attribute defined at extension commons.

See Also:

• Constant Field Values

FORMAT

public static final String FORMAT

Generated constant - Attribute key of Document.format attribute defined at extension commons.

See Also:

• Constant Field Values

SOURCEITEM

public static final String SOURCEITEM

Generated constant - Attribute key of Document.sourceItem attribute defined at extension commons.

See Also:

• Constant Field Values

Constructor Details

DocumentModel

public DocumentModel()

Generated constructor - Default constructor for generic creation.

DocumentModel

public DocumentModel(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

DocumentModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public DocumentModel(CatalogVersionModel _catalogVersion,
 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,
 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 Details

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 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(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