de.hybris.platform.btgcockpit.service.context

Class DefaultRestrictionActionCreateContext

java.lang.Object

de.hybris.platform.btgcockpit.service.context.DefaultRestrictionActionCreateContext

All Implemented Interfaces:

RestrictionActionCreateContext

public class DefaultRestrictionActionCreateContext
extends Object
implements RestrictionActionCreateContext

Default implementation of RestrictionActionCreateContext.

Constructor Summary

Constructors

Constructor and Description
DefaultRestrictionActionCreateContext()
DefaultRestrictionActionCreateContext(boolean attachedToComponent)

Method Summary

Modifier and Type	Method and Description
TypedObject	getAltComponent() Returns current component reference that is attached with this context.
Object	getAttribute(String code) This method allows us to retrieve some additional (custom) attributes.
Map<String,Object>	getAttributeMap()
Map<String,Object>	getAttributes() Gets all additional attributes.
TypedObject	getComponentReference() Returns alternative component reference that is attached with this context.
TypedObject	getCurrentSegment() Returns current segment that is attached with this context.
TypedObject	getPageReference() Returns current page reference that is attached with this context.
boolean	isAddSegmentRestrToPage() Checks whether segment restriction should be assigned to existing page.
boolean	isAttachedToComponent() Determines whether following informations are valid for component.
boolean	isInverted() Checks whether we should invert a restriction.
boolean	isShowAltComponent()
boolean	isUseExistingRestrictions() Checks whether we can use existing restrictions for personalized page.
boolean	isVisibleForFulfilled() Checks whether attached page or component should be visible for user that fulfilled current segment.
void	removeAttribute(String key) Remove specified attribute.
void	removeAttributes() Removes all stored attributes.
void	setAddSegmentRestrToPage(boolean addSegmentRestrToPage)
void	setAltComponent(TypedObject altComponent)
void	setAttachedToComponent(boolean attachedToComponent)
void	setAttribute(String code, Object value) Sets specified additional value.
void	setComponentReference(TypedObject componentReference)
void	setCurrentSegment(TypedObject currentSegment)
void	setInverted(boolean inverted)
void	setPageReference(TypedObject pageReference)
void	setShowAltComponent(boolean showAltComponent)
void	setUseExistingRestrictions(boolean useExistingRestrictions)
void	setVisibleForFulfilled(boolean visibleForFulfilled)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRestrictionActionCreateContext

public DefaultRestrictionActionCreateContext(boolean attachedToComponent)

DefaultRestrictionActionCreateContext

public DefaultRestrictionActionCreateContext()

Method Detail

setAttachedToComponent

public void setAttachedToComponent(boolean attachedToComponent)

setComponentReference

public void setComponentReference(TypedObject componentReference)

getAttributeMap

public Map<String,Object> getAttributeMap()

setPageReference

public void setPageReference(TypedObject pageReference)

setVisibleForFulfilled

public void setVisibleForFulfilled(boolean visibleForFulfilled)

setInverted

public void setInverted(boolean inverted)

setAltComponent

public void setAltComponent(TypedObject altComponent)

setAddSegmentRestrToPage

public void setAddSegmentRestrToPage(boolean addSegmentRestrToPage)

setUseExistingRestrictions

public void setUseExistingRestrictions(boolean useExistingRestrictions)

setCurrentSegment

public void setCurrentSegment(TypedObject currentSegment)

getAttribute

public Object getAttribute(String code)

Description copied from interface: RestrictionActionCreateContext

This method allows us to retrieve some additional (custom) attributes.

Specified by:

getAttribute in interface RestrictionActionCreateContext

Parameters:

code - additional attribute qualifier

Returns:

additional value

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: RestrictionActionCreateContext

Gets all additional attributes.

Specified by:

getAttributes in interface RestrictionActionCreateContext

isAttachedToComponent

public boolean isAttachedToComponent()

Description copied from interface: RestrictionActionCreateContext

Determines whether following informations are valid for component.

Specified by:

isAttachedToComponent in interface RestrictionActionCreateContext

removeAttribute

public void removeAttribute(String key)

Description copied from interface: RestrictionActionCreateContext

Remove specified attribute.

Specified by:

removeAttribute in interface RestrictionActionCreateContext

Parameters:

key - given attribute qualifier

removeAttributes

public void removeAttributes()

Description copied from interface: RestrictionActionCreateContext

Removes all stored attributes.

Specified by:

removeAttributes in interface RestrictionActionCreateContext

setAttribute

public void setAttribute(String code,
                         Object value)

Description copied from interface: RestrictionActionCreateContext

Sets specified additional value.

Specified by:

setAttribute in interface RestrictionActionCreateContext

Parameters:

code - additional attribute qualifier

value - additional value

getComponentReference

public TypedObject getComponentReference()

Description copied from interface: RestrictionActionCreateContext

Returns alternative component reference that is attached with this context.

Specified by:

getComponentReference in interface RestrictionActionCreateContext

isVisibleForFulfilled

public boolean isVisibleForFulfilled()

Description copied from interface: RestrictionActionCreateContext

Checks whether attached page or component should be visible for user that fulfilled current segment.

Specified by:

isVisibleForFulfilled in interface RestrictionActionCreateContext

isInverted

public boolean isInverted()

Description copied from interface: RestrictionActionCreateContext

Checks whether we should invert a restriction.

Specified by:

isInverted in interface RestrictionActionCreateContext

getAltComponent

public TypedObject getAltComponent()

Description copied from interface: RestrictionActionCreateContext

Returns current component reference that is attached with this context.

Specified by:

getAltComponent in interface RestrictionActionCreateContext

getPageReference

public TypedObject getPageReference()

Description copied from interface: RestrictionActionCreateContext

Returns current page reference that is attached with this context.

Specified by:

getPageReference in interface RestrictionActionCreateContext

isAddSegmentRestrToPage

public boolean isAddSegmentRestrToPage()

Description copied from interface: RestrictionActionCreateContext

Checks whether segment restriction should be assigned to existing page.

Specified by:

isAddSegmentRestrToPage in interface RestrictionActionCreateContext

isUseExistingRestrictions

public boolean isUseExistingRestrictions()

Description copied from interface: RestrictionActionCreateContext

Checks whether we can use existing restrictions for personalized page.

Specified by:

isUseExistingRestrictions in interface RestrictionActionCreateContext

getCurrentSegment

public TypedObject getCurrentSegment()

Description copied from interface: RestrictionActionCreateContext

Returns current segment that is attached with this context.

Specified by:

getCurrentSegment in interface RestrictionActionCreateContext

setShowAltComponent

public void setShowAltComponent(boolean showAltComponent)

isShowAltComponent

public boolean isShowAltComponent()

Specified by:

isShowAltComponent in interface RestrictionActionCreateContext