de.hybris.platform.jalo.type

Interface AttributeAccess

All Known Implementing Classes:

AbstractNonChangeableAttributeAccess, ConstantAttributeAccess, LocalizableFeatureAccess, OneToManyRelationAttributeAccess, PropertyAccess, ReflectionAttributeAccess, RelationAttributeAccess

public interface AttributeAccess

The attribute access implementation interface. Any attribute which cannot be mapped to a property or relation must be provided ( via Item.registerAccessFor(Class, String, AttributeAccess)) a object implementing this interface.

The access implements generic data storage and retrieval. It is legal to throw an JaloInvalidParameterException to indicate that some functionality is not available.

Method Summary

Modifier and Type	Method and Description
Object	getValue(SessionContext ctx, Item item) Retrieves the attribute data from a given item.
void	setValue(SessionContext ctx, Item item, Object value) Stores the attribute data for a given item.

Method Detail

setValue

void setValue(SessionContext ctx,
              Item item,
              Object value)
       throws JaloTypeException,
              JaloInvalidParameterException,
              JaloSecurityException,
              JaloBusinessException

Stores the attribute data for a given item.

Parameters:

ctx - the current session context - e.g. specifies the session language

item - the item to store data for

value - the value to store

Throws:

JaloTypeException - in case the attribute type does not allow storing this value

JaloInvalidParameterException - in case the value is not compatible with this attribute

JaloSecurityException - in case there are security constraints which do not allow this value to be written

JaloBusinessException - any other error

getValue

Object getValue(SessionContext ctx,
                Item item)
         throws JaloTypeException,
                JaloInvalidParameterException,
                JaloSecurityException

Retrieves the attribute data from a given item. Primitive data types like int are wrapped into their object instances.

Parameters:

ctx - the current session context - e.g. specifies the session language

item - the item to get data from

Returns:

the data value

Throws:

JaloTypeException - in case the attribute type does not allow reading this value

JaloInvalidParameterException - in some data required for reading the value is missing or not as expected ( like missing session language )

JaloSecurityException - in case there are security constraints which do not allow reding this value