de.hybris.platform.btgcockpit.service.context

Interface RestrictionActionCreateContext

All Known Implementing Classes:

DefaultRestrictionActionCreateContext

public interface RestrictionActionCreateContext

Stores necessary information in order to create an CmsRestrictionActionDefinition.

Note:
For details please see default implementation DefaultRestrictionActionCreateContext.

Method Summary

Modifier and Type	Method and Description
TypedObject	getAltComponent() Returns current component reference that is attached with this context.
Object	getAttribute(String attribute) This method allows us to retrieve some additional (custom) attributes.
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 attribute) Remove specified attribute.
void	removeAttributes() Removes all stored attributes.
void	setAttribute(String attribute, Object value) Sets specified additional value.

Method Detail

isAttachedToComponent

boolean isAttachedToComponent()

Determines whether following informations are valid for component.

getAttribute

Object getAttribute(String attribute)

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

Parameters:

attribute - additional attribute qualifier

Returns:

additional value

getAttributes

Map<String,Object> getAttributes()

Gets all additional attributes.

removeAttributes

void removeAttributes()

Removes all stored attributes.

removeAttribute

void removeAttribute(String attribute)

Remove specified attribute.

Parameters:

attribute - given attribute qualifier

setAttribute

void setAttribute(String attribute,
                  Object value)

Sets specified additional value.

Parameters:

attribute - additional attribute qualifier

value - additional value

getCurrentSegment

TypedObject getCurrentSegment()

Returns current segment that is attached with this context.

isUseExistingRestrictions

boolean isUseExistingRestrictions()

Checks whether we can use existing restrictions for personalized page.

isAddSegmentRestrToPage

boolean isAddSegmentRestrToPage()

Checks whether segment restriction should be assigned to existing page.

getPageReference

TypedObject getPageReference()

Returns current page reference that is attached with this context.

getAltComponent

TypedObject getAltComponent()

Returns current component reference that is attached with this context.

isInverted

boolean isInverted()

Checks whether we should invert a restriction.

isVisibleForFulfilled

boolean isVisibleForFulfilled()

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

getComponentReference

TypedObject getComponentReference()

Returns alternative component reference that is attached with this context.

isShowAltComponent

boolean isShowAltComponent()