de.hybris.platform.util

Class ViewResultItem

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.util.ViewResultItem

All Implemented Interfaces:

JaloOnlyItem, JaloOnlySingletonItem, java.io.Serializable, java.lang.Comparable

public final class ViewResultItem
extends Item
implements JaloOnlySingletonItem

Represents the result of a search which was initiated by a ViewType

See Also:

Serialized Form

Nested Class Summary

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

Modifier	Constructor and Description
	ViewResultItem()
protected	ViewResultItem(ComposedType type, java.util.Map values)

Method Summary

Modifier and Type	Method and Description
Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Returns an instance of this class.
java.lang.Object	doGetAttribute(SessionContext ctx, java.lang.String qualifier) Should get the value of the given attribute if no AttributeAccess has been registered for it.
void	doSetAttribute(SessionContext ctx, java.lang.String qualifier, java.lang.Object value) Should set the value of the given attribute if no AttributeAccess has been registered for it.
protected Item.ItemAttributeMap	getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes) Defines all attributes which should be set after item creation.
ComposedType	provideComposedType() Should provide the composed type of this item.
java.util.Date	provideCreationTime() Should provide a fixed creation time for this item.
java.util.Date	provideModificationTime() Should provide a modification time for this item.
PK	providePK() Should provide a fixed PK for this item.
void	removeJaloOnly() no-op

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, checkRemovable, clearPermission, compareTo, createNonClassAccessor, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getImplementation, 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, 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, toString, 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

Constructor Detail

ViewResultItem

public ViewResultItem()

ViewResultItem

protected ViewResultItem(ComposedType type,
                         java.util.Map values)

Method Detail

createItem

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

Returns an instance of this class.

Specified by:

createItem in class Item

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

getNonInitialAttributes

protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx,
                                                        Item.ItemAttributeMap allAttributes)

Description copied from class: Item

Defines all attributes which should be set after item creation. this is done be removing all attributes which are already set by Item.createItem(SessionContext, ComposedType, ItemAttributeMap).

use it like this:

 protected ItemAttributeMap getNonInitialAttributes( SessionContext ctx, ItemAttributeMap allAttributes ) {
 // let all superclasses remove their intial attributes too final ItemAttributeMap attributes =
 super.getNonInitialAttributes( ctx, allAttributes ); // remove own initial attributes here attributes.remove(
 MyItem.MY_INITIAL_ATTR ); return ret; }

 

it is vital to optain the map via super.getNonInitialAttributes and pass it on as such since this ensures that attribute qualifiers are treated case insensitive!

Overrides:

getNonInitialAttributes in class Item

Parameters:

ctx - session context with language = NULL

allAttributes - a ItemAttributeMap contaning attribute values.

Returns:

empty map since createItem(de.hybris.platform.jalo.SessionContext, de.hybris.platform.jalo.type.ComposedType, de.hybris.platform.jalo.Item.ItemAttributeMap) has already stored all attributes and we have to avoid calls to setAttribute().

removeJaloOnly

public void removeJaloOnly()
                    throws ConsistencyCheckException

no-op

Specified by:

removeJaloOnly in interface JaloOnlyItem

Throws:

ConsistencyCheckException - to signal that this item removal failed

providePK

public PK providePK()

Description copied from interface: JaloOnlyItem

Should provide a fixed PK for this item.

Specified by:

providePK in interface JaloOnlyItem

Returns:

PK of this item

provideComposedType

public ComposedType provideComposedType()

Description copied from interface: JaloOnlyItem

Should provide the composed type of this item.

Specified by:

provideComposedType in interface JaloOnlyItem

Returns:

ComposedType of this item

provideCreationTime

public java.util.Date provideCreationTime()

Description copied from interface: JaloOnlyItem

Should provide a fixed creation time for this item.

Specified by:

provideCreationTime in interface JaloOnlyItem

Returns:

creation time date of this item

provideModificationTime

public java.util.Date provideModificationTime()

Description copied from interface: JaloOnlyItem

Should provide a modification time for this item.

Specified by:

provideModificationTime in interface JaloOnlyItem

Returns:

modification time date of this item

doGetAttribute

public java.lang.Object doGetAttribute(SessionContext ctx,
                                       java.lang.String qualifier)

Description copied from interface: JaloOnlyItem

Should get the value of the given attribute if no AttributeAccess has been registered for it. Otherwise the value is read from the access instance.

Specified by:

doGetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

qualifier - the qualifier of the requested attribute

Returns:

the attribute value

doSetAttribute

public void doSetAttribute(SessionContext ctx,
                           java.lang.String qualifier,
                           java.lang.Object value)
                    throws JaloBusinessException

Description copied from interface: JaloOnlyItem

Should set the value of the given attribute if no AttributeAccess has been registered for it. Otherwise the value is read from the access instance.

Specified by:

doSetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

qualifier - the qualifier of the requested attribute

value - the new attribute value

Throws:

JaloSecurityException - in case the session user is not allowed to write this attribute

JaloBusinessException - in case any other error occured