Package 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:
Serializable,Comparable
- Direct Known Subclasses:
Document
Generated class for type
Document.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem
GenericItem.GenericItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImplNested 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
FieldsModifier and TypeFieldDescriptionprotected static final Map<String,Item.AttributeMode> static final StringQualifier of theDocument.formatattributestatic final StringQualifier of theDocument.itemTimestampattributestatic final StringQualifier of theDocument.sourceItemattributeprotected static final BidirectionalOneToManyHandler<GeneratedDocument>BidirectionalOneToManyHandlerfor 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, URL2Fields inherited from class de.hybris.platform.jalo.media.GeneratedMedia
ALTTEXT, CODE, DERIVEDMEDIAS, DERIVEDMEDIASHANDLER, DESCRIPTION, FOLDER, INTERNALURL, MEDIACONTAINER, MEDIACONTAINERHANDLER, MEDIAFORMAT, REMOVABLE, SUBFOLDERPATHFields inherited from class de.hybris.platform.jalo.media.GeneratedAbstractMedia
DATAPK, LOCATION, LOCATIONHASH, MIME, REALFILENAME, SIZEFields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLEDFields 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, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPEFields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ItemcreateItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.protected Map<String,Item.AttributeMode> Generated method - Getter of theDocument.formatattribute.getFormat(SessionContext ctx) Generated method - Getter of theDocument.formatattribute.Generated method - Getter of theDocument.itemTimestampattribute.Generated method - Getter of theDocument.itemTimestampattribute.Generated method - Getter of theDocument.sourceItemattribute.Generated method - Getter of theDocument.sourceItemattribute.protected voidGenerated method - Setter of theDocument.formatattribute.protected voidsetFormat(SessionContext ctx, Format value) Generated method - Setter of theDocument.formatattribute.voidsetItemTimestamp(SessionContext ctx, Date value) Generated method - Setter of theDocument.itemTimestampattribute.voidsetItemTimestamp(Date value) Generated method - Setter of theDocument.itemTimestampattribute.protected voidsetSourceItem(Item value) Generated method - Setter of theDocument.sourceItemattribute.protected voidsetSourceItem(SessionContext ctx, Item value) Generated method - Setter of theDocument.sourceItemattribute.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, toStringMethods 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, setSubFolderPathMethods 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, setSizeMethods inherited from class de.hybris.platform.jalo.GenericItem
getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, getRelatedItems, setRelatedItemsMethods 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, setLocalizedPropertyMethods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setPropertyMethods 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, getPartOfRemovedSessionMarker, 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, suppressRelation, useTA, writeReplaceMethods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
Field Details
-
ITEMTIMESTAMP
Qualifier of theDocument.itemTimestampattribute- See Also:
-
FORMAT
Qualifier of theDocument.formatattribute- See Also:
-
SOURCEITEM
Qualifier of theDocument.sourceItemattribute- See Also:
-
SOURCEITEMHANDLER
BidirectionalOneToManyHandlerfor handling 1:n SOURCEITEM's relation attributes from 'one' side. -
DEFAULT_INITIAL_ATTRIBUTES
-
-
Constructor Details
-
GeneratedDocument
public GeneratedDocument()
-
-
Method Details
-
getDefaultAttributeModes
- Overrides:
getDefaultAttributeModesin classGeneratedMedia
-
createItem
protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException Description copied from class:ItemHas 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. ) duringComposedType.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:
createItemin classMedia- Parameters:
ctx- the current session context which this item is created withintype- 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
Generated method - Getter of theDocument.formatattribute.- Returns:
- the format - The format of the document
-
getFormat
Generated method - Getter of theDocument.formatattribute.- Returns:
- the format - The format of the document
-
setFormat
Generated method - Setter of theDocument.formatattribute.- Parameters:
value- the format - The format of the document
-
setFormat
Generated method - Setter of theDocument.formatattribute.- Parameters:
value- the format - The format of the document
-
getItemTimestamp
Generated method - Getter of theDocument.itemTimestampattribute.- 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
Generated method - Getter of theDocument.itemTimestampattribute.- 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
Generated method - Setter of theDocument.itemTimestampattribute.- 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
Generated method - Setter of theDocument.itemTimestampattribute.- 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
Generated method - Getter of theDocument.sourceItemattribute.- Returns:
- the sourceItem
-
getSourceItem
Generated method - Getter of theDocument.sourceItemattribute.- Returns:
- the sourceItem
-
setSourceItem
Generated method - Setter of theDocument.sourceItemattribute.- Parameters:
value- the sourceItem
-
setSourceItem
Generated method - Setter of theDocument.sourceItemattribute.- Parameters:
value- the sourceItem
-