de.hybris.platform.btgcockpit.service

Interface BTGCockpitService

All Known Implementing Classes:

DefaultBTGCockpitService

public interface BTGCockpitService

Method Summary

Modifier and Type	Method and Description
TypedObject	createBtgSegment(String segmentName, TypedObject catalogVersion) Creates a btgSegment with the given name in the given catalogVersion.
TypedObject	createCmsRestrictionAction(TypedObject segment, TypedObject restrictedCMSItem, boolean inverted) Creates a CMS Restriction Action with a according CMS Restriction and connects it with the segment and the CMS Item.
TypedObject	createShowItemOutputAction(RestrictionActionCreateContext context) Creates show item output action accordingly to given context.
TypedObject	getCatalogVersion(TypedObject segment) Get the catalog version for the specific BTGSegment
TypedObject	getDefaultBtgCatalogVersion() Gets the default catalog version for btg segments or null, if none configured.
List<TypedObject>	getOutputActions(TypedObject segment) Get the output actions for a specific BTGSegment
List<TypedObject>	getRules(TypedObject segment) Get the rules for a specific BTGSegment
void	removeBTGOutputAction(TypedObject btgoutputAction) Removes the specific BTGOutputAction
void	removeBTGRule(TypedObject btgrule) Removes the specific BTGRule
void	removeBTGSegment(TypedObject btgsegment) Removes the specific BTGSegment
void	setOutputActions(TypedObject segment, List<TypedObject> outputActions) Set the output actions for a specific BTGSegment
void	setRules(TypedObject segment, List<TypedObject> rules) Set the rules for a specific BTGSegment
void	setSegmentNameAccordingToFirstRule(TypedObject btgSegment) Sets the name of the segment according to the first rule.

Method Detail

removeBTGSegment

void removeBTGSegment(TypedObject btgsegment)
               throws ValueHandlerPermissionException

Removes the specific BTGSegment

Parameters:

btgsegment - the BTGSegment to be removed

Throws:

ValueHandlerPermissionException

removeBTGRule

void removeBTGRule(TypedObject btgrule)
            throws ValueHandlerPermissionException

Removes the specific BTGRule

Parameters:

btgrule - the BTGRule to be removed

Throws:

ValueHandlerPermissionException

removeBTGOutputAction

void removeBTGOutputAction(TypedObject btgoutputAction)
                    throws ValueHandlerPermissionException

Removes the specific BTGOutputAction

Parameters:

btgoutputAction - the BTGOutputAction to be removed

Throws:

ValueHandlerPermissionException

getRules

List<TypedObject> getRules(TypedObject segment)

Get the rules for a specific BTGSegment

Parameters:

segment - the BTGSegment

Returns:

the rules, wrapped into TypedObjects

setRules

void setRules(TypedObject segment,
              List<TypedObject> rules)

Set the rules for a specific BTGSegment

Parameters:

segment - the BTGSegment

rules - the rules, wrapped into TypedObjects

getOutputActions

List<TypedObject> getOutputActions(TypedObject segment)

Get the output actions for a specific BTGSegment

Parameters:

segment - the BTGSegment

Returns:

the output actions, wrapped into TypedObjects

setOutputActions

void setOutputActions(TypedObject segment,
                      List<TypedObject> outputActions)

Set the output actions for a specific BTGSegment

Parameters:

segment - the BTGSegment

outputActions - the output actions, wrapped into TypedObjects

getCatalogVersion

TypedObject getCatalogVersion(TypedObject segment)

Get the catalog version for the specific BTGSegment

Parameters:

segment - the BTGSegment

Returns:

the catalog version, wrapped into TypedObject

createShowItemOutputAction

TypedObject createShowItemOutputAction(RestrictionActionCreateContext context)

Creates show item output action accordingly to given context.

Note:
This creates a CmsRestrictionActionDefinition for a given segment RestrictionActionCreateContext.getCurrentSegment(), also creates a proper restriction base on context information.

Parameters:

context - given context information

Returns:

wrapped instance of CmsRestrictionActionDefinition

createBtgSegment

TypedObject createBtgSegment(String segmentName,
                             TypedObject catalogVersion)

Creates a btgSegment with the given name in the given catalogVersion.

createCmsRestrictionAction

TypedObject createCmsRestrictionAction(TypedObject segment,
                                       TypedObject restrictedCMSItem,
                                       boolean inverted)

Creates a CMS Restriction Action with a according CMS Restriction and connects it with the segment and the CMS Item. CMS Sites related to the CMSItem will be added to the segments sites.

Parameters:

segment - the segment to which the Restriction Action will be added.

restrictedCMSItem - the CMS Item (Page or Component) to which the restriction will be added.

inverted - if set to true, users from the segment will not see the CMS Item. Otherwise only users from the segment can see it.

Returns:

the newly created CmsRestrictionActionDefinitionModel, wrapped into a TypedObject

getDefaultBtgCatalogVersion

TypedObject getDefaultBtgCatalogVersion()

Gets the default catalog version for btg segments or null, if none configured.

setSegmentNameAccordingToFirstRule

void setSegmentNameAccordingToFirstRule(TypedObject btgSegment)

Sets the name of the segment according to the first rule.