de.hybris.platform.commons.jalo

Class GeneratedDocument

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.jalo.media.GeneratedAbstractMedia

de.hybris.platform.jalo.media.AbstractMedia

de.hybris.platform.jalo.media.GeneratedMedia

de.hybris.platform.jalo.media.Media

de.hybris.platform.commons.jalo.GeneratedDocument

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

Document

public abstract class GeneratedDocument
extends Media

Generated class for type Document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Map<java.lang.String,Item.AttributeMode>	DEFAULT_INITIAL_ATTRIBUTES
static java.lang.String	FORMAT Qualifier of the Document.format attribute
static java.lang.String	ITEMTIMESTAMP Qualifier of the Document.itemTimestamp attribute
static java.lang.String	SOURCEITEM Qualifier of the Document.sourceItem attribute
protected static BidirectionalOneToManyHandler<GeneratedDocument>	SOURCEITEMHANDLER BidirectionalOneToManyHandler for handling 1:n SOURCEITEM's relation attributes from 'one' side.

Fields inherited from class de.hybris.platform.jalo.media.Media

FROM_JAR, HASDATA, ISONSERVER, PICTURE, THUMBNAIL, URL, URL2

Fields inherited from class de.hybris.platform.jalo.media.GeneratedMedia

ALTTEXT, CODE, DERIVEDMEDIAS, DERIVEDMEDIASHANDLER, DESCRIPTION, FOLDER, INTERNALURL, MEDIACONTAINER, MEDIACONTAINERHANDLER, MEDIAFORMAT, REMOVABLE, SUBFOLDERPATH

Fields inherited from class de.hybris.platform.jalo.media.GeneratedAbstractMedia

DATAPK, LOCATION, LOCATIONHASH, MIME, REALFILENAME, SIZE

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
GeneratedDocument()

Method Summary

Modifier and Type	Method and Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
protected java.util.Map<java.lang.String,Item.AttributeMode>	getDefaultAttributeModes()
Format	getFormat() Generated method - Getter of the Document.format attribute.
Format	getFormat(SessionContext ctx) Generated method - Getter of the Document.format attribute.
java.util.Date	getItemTimestamp() Generated method - Getter of the Document.itemTimestamp attribute.
java.util.Date	getItemTimestamp(SessionContext ctx) Generated method - Getter of the Document.itemTimestamp attribute.
Item	getSourceItem() Generated method - Getter of the Document.sourceItem attribute.
Item	getSourceItem(SessionContext ctx) Generated method - Getter of the Document.sourceItem attribute.
protected void	setFormat(Format value) Generated method - Setter of the Document.format attribute.
protected void	setFormat(SessionContext ctx, Format value) Generated method - Setter of the Document.format attribute.
void	setItemTimestamp(java.util.Date value) Generated method - Setter of the Document.itemTimestamp attribute.
void	setItemTimestamp(SessionContext ctx, java.util.Date value) Generated method - Setter of the Document.itemTimestamp attribute.
protected void	setSourceItem(Item value) Generated method - Setter of the Document.sourceItem attribute.
protected void	setSourceItem(SessionContext ctx, Item value) Generated method - Setter of the Document.sourceItem attribute.

Methods inherited from class de.hybris.platform.jalo.media.Media

checkRemovable, copyToTempFile, getData, getDataFromInputStream, getDataFromInputStreamSure, getDataFromStream, getDataFromStreamSure, getDeniedPrincipals, getDeniedPrincipals, getDownloadURL, getDownloadURL, getFile, getFileExtensionFromMime, getFileName, getFileNameForFileBasedSoftware, getFiles, getFolder, getForContext, getForeignDataOwners, getForeignDataOwners, getInFormat, getLocation, getPermittedPrincipals, getPermittedPrincipals, getURL, getURL, getURL2, getURL2, getZipEntries, getZipEntryNames, hasData, hasForeignDataOwners, isOnServer, isRemovableAsPrimitive, moveData, moveDataTo, moveMedia, moveMedia, relocateData, remove, removeData, setData, setData, setData, setData, setData, setData, setData, setData, setDataByURL, setDataFromStream, setDataFromStream, setDataPK, setDeniedPrincipals, setDeniedPrincipals, setFile, setFile, setPermittedPrincipals, setPermittedPrincipals, setSize, setURL, setURL, setURL2, setURL2, toString

Methods inherited from class de.hybris.platform.jalo.media.GeneratedMedia

addToDerivedMedias, addToDerivedMedias, getAltText, getAltText, getCode, getCode, getDerivedMedias, getDerivedMedias, getDescription, getDescription, getFolder, getInternalURL, getInternalURL, getMediaContainer, getMediaContainer, getMediaFormat, getMediaFormat, getSubFolderPath, getSubFolderPath, isRemovable, isRemovable, isRemovableAsPrimitive, removeFromDerivedMedias, removeFromDerivedMedias, setAltText, setAltText, setCode, setCode, setDerivedMedias, setDerivedMedias, setDescription, setDescription, setFolder, setFolder, setInternalURL, setInternalURL, setMediaContainer, setMediaContainer, setMediaFormat, setMediaFormat, setRemovable, setRemovable, setRemovable, setRemovable, setSubFolderPath, setSubFolderPath

Methods inherited from class de.hybris.platform.jalo.media.GeneratedAbstractMedia

getDataPK, getDataPK, getDataPKAsPrimitive, getDataPKAsPrimitive, getLocation, getLocationHash, getLocationHash, getMime, getMime, getRealFileName, getRealFileName, getSize, getSize, getSizeAsPrimitive, getSizeAsPrimitive, setDataPK, setDataPK, setDataPK, setLocation, setLocation, setLocationHash, setLocationHash, setMime, setMime, setRealFileName, setRealFileName, setSize, setSize, setSize

Methods inherited from class de.hybris.platform.jalo.GenericItem

getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getImplementation, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

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

Field Detail

ITEMTIMESTAMP

public static final java.lang.String ITEMTIMESTAMP

Qualifier of the Document.itemTimestamp attribute

See Also:

Constant Field Values

FORMAT

public static final java.lang.String FORMAT

Qualifier of the Document.format attribute

See Also:

Constant Field Values

SOURCEITEM

public static final java.lang.String SOURCEITEM

Qualifier of the Document.sourceItem attribute

See Also:

Constant Field Values

SOURCEITEMHANDLER

protected static final BidirectionalOneToManyHandler<GeneratedDocument> SOURCEITEMHANDLER

BidirectionalOneToManyHandler for handling 1:n SOURCEITEM's relation attributes from 'one' side.

DEFAULT_INITIAL_ATTRIBUTES

protected static final java.util.Map<java.lang.String,Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES

Constructor Detail

GeneratedDocument

public GeneratedDocument()

Method Detail

getDefaultAttributeModes

protected java.util.Map<java.lang.String,Item.AttributeMode> getDefaultAttributeModes()

Overrides:

getDefaultAttributeModes in class GeneratedMedia

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class Media

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getFormat

public Format getFormat(SessionContext ctx)

Generated method - Getter of the Document.format attribute.

Returns:

the format - The format of the document

getFormat

public Format getFormat()

Generated method - Getter of the Document.format attribute.

Returns:

the format - The format of the document

setFormat

protected void setFormat(SessionContext ctx,
                         Format value)

Generated method - Setter of the Document.format attribute.

Parameters:

value - the format - The format of the document

setFormat

protected void setFormat(Format value)

Generated method - Setter of the Document.format attribute.

Parameters:

value - the format - The format of the document

getItemTimestamp

public java.util.Date getItemTimestamp(SessionContext ctx)

Generated method - Getter of the Document.itemTimestamp attribute.

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.

getItemTimestamp

public java.util.Date getItemTimestamp()

Generated method - Getter of the Document.itemTimestamp attribute.

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.

setItemTimestamp

public void setItemTimestamp(SessionContext ctx,
                             java.util.Date value)

Generated method - Setter of the Document.itemTimestamp attribute.

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.

setItemTimestamp

public void setItemTimestamp(java.util.Date value)

Generated method - Setter of the Document.itemTimestamp attribute.

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.

getSourceItem

public Item getSourceItem(SessionContext ctx)

Generated method - Getter of the Document.sourceItem attribute.

Returns:

the sourceItem

getSourceItem

public Item getSourceItem()

Generated method - Getter of the Document.sourceItem attribute.

Returns:

the sourceItem

setSourceItem

protected void setSourceItem(SessionContext ctx,
                             Item value)

Generated method - Setter of the Document.sourceItem attribute.

Parameters:

value - the sourceItem

setSourceItem

protected void setSourceItem(Item value)

Generated method - Setter of the Document.sourceItem attribute.

Parameters:

value - the sourceItem