de.hybris.platform.util

Class OneToManyHandler<T extends Item>

java.lang.Object

de.hybris.platform.util.OneToManyHandler<T>

Direct Known Subclasses:

BidirectionalOneToManyHandler

public class OneToManyHandler<T extends Item>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	foreignKeyAttr
protected String	handlerMode

Constructor Summary

Constructors

Constructor and Description
OneToManyHandler(String targetItemType, boolean partOf, String foreignKeyAttr, String orderNumberAttr, boolean reorderable, boolean asc)
OneToManyHandler(String targetItemType, boolean partOf, String foreignKeyAttr, String orderNumberAttr, boolean reorderable, boolean asc, int typeOfCollection)
OneToManyHandler(String targetItemType, boolean partOf, String foreignKeyAttr, String orderNumberAttr, boolean reorderable, boolean asc, int typeOfCollection, String conditionQuery)

Method Summary

Modifier and Type	Method and Description
void	addValue(SessionContext ctx, Item key, T toLink)
String	getConditionQuery()
String	getForeignKeyAttr()
int	getNextOrderNumber(SessionContext ctx, Item key)
String	getOrderNumberAttr()
Collection<T>	getValues(SessionContext ctx, Item key)
boolean	isPartOf()
boolean	isReOrderable()
void	newInstance(SessionContext ctx, Item.ItemAttributeMap attributes)
void	notifyKeyRemoval(SessionContext ctx, Item key)
void	removeValue(SessionContext ctx, Item key, T linked)
SearchResult	searchForLinkedItems(PK pk)
protected void	setForeignKeyValue(SessionContext ctx, Item key, T toLink) sets a foreign key property foreignKeyAttr for source item T
protected void	setPosAttributeValue(SessionContext ctx, T toLink, int index) sets a _pos attribute (orderNumberAttr) related for foreignKeyAttr for source item T
void	setValues(SessionContext ctx, Item key, Collection<T> values)
protected boolean	setValuesInternal(SessionContext ctx, Item key, Collection<T> values)
protected boolean	useLegacyMode() If returns true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handlerMode

protected final String handlerMode

foreignKeyAttr

protected final String foreignKeyAttr

Constructor Detail

OneToManyHandler

public OneToManyHandler(String targetItemType,
                        boolean partOf,
                        String foreignKeyAttr,
                        String orderNumberAttr,
                        boolean reorderable,
                        boolean asc)

OneToManyHandler

public OneToManyHandler(String targetItemType,
                        boolean partOf,
                        String foreignKeyAttr,
                        String orderNumberAttr,
                        boolean reorderable,
                        boolean asc,
                        int typeOfCollection)

OneToManyHandler

public OneToManyHandler(String targetItemType,
                        boolean partOf,
                        String foreignKeyAttr,
                        String orderNumberAttr,
                        boolean reorderable,
                        boolean asc,
                        int typeOfCollection,
                        String conditionQuery)

Method Detail

useLegacyMode

protected boolean useLegacyMode()

If returns true. The regular set attribute setForeignKeyValue(SessionContext, Item, Item) is called, otherwise a positioning logic is used while setting reference, this affects relative position in ordered collections.

searchForLinkedItems

public SearchResult searchForLinkedItems(PK pk)

getValues

public Collection<T> getValues(SessionContext ctx,
                               Item key)

getNextOrderNumber

public int getNextOrderNumber(SessionContext ctx,
                              Item key)

setValuesInternal

protected boolean setValuesInternal(SessionContext ctx,
                                    Item key,
                                    Collection<T> values)

setValues

public void setValues(SessionContext ctx,
                      Item key,
                      Collection<T> values)

addValue

public void addValue(SessionContext ctx,
                     Item key,
                     T toLink)

newInstance

public void newInstance(SessionContext ctx,
                        Item.ItemAttributeMap attributes)

setForeignKeyValue

protected void setForeignKeyValue(SessionContext ctx,
                                  Item key,
                                  T toLink)
                           throws JaloSecurityException,
                                  JaloBusinessException

sets a foreign key property foreignKeyAttr for source item T

Throws:

JaloSecurityException

JaloBusinessException

setPosAttributeValue

protected void setPosAttributeValue(SessionContext ctx,
                                    T toLink,
                                    int index)
                             throws JaloSecurityException,
                                    JaloBusinessException

sets a _pos attribute (orderNumberAttr) related for foreignKeyAttr for source item T

Throws:

JaloSecurityException

JaloBusinessException

removeValue

public void removeValue(SessionContext ctx,
                        Item key,
                        T linked)

notifyKeyRemoval

public void notifyKeyRemoval(SessionContext ctx,
                             Item key)

getForeignKeyAttr

public String getForeignKeyAttr()

getOrderNumberAttr

public String getOrderNumberAttr()

isReOrderable

public boolean isReOrderable()

isPartOf

public boolean isPartOf()

getConditionQuery

public String getConditionQuery()