de.hybris.platform.btg.services

Interface ExpressionService

All Known Implementing Classes:

DefaultExpressionService

public interface ExpressionService

This interfaces provides information about types of BTGOperandModel and BTGOperatorModel that can be used in order to create an BTGExpressionModel for a given BTGRuleModel.

Method Summary

Modifier and Type	Method and Description
BTGConditionModel	createExpression(BTGOperandModel leftOperand, BTGOperatorModel operator, BTGOperandModel rightOperand, CatalogVersionModel catalogVersion) Creates a new BTG expression.
BTGOperatorModel	createOperator(java.lang.String operatorString, CatalogVersionModel catalogVersion) Creates an operator
java.util.Collection<java.lang.Class<? extends BTGOperandModel>>	getAvailableLeftOperandTypes(BTGRuleType ruleType) Provides information about possible types for the left operand than is used to create an expression for some existing rule.
java.util.Collection<java.lang.String>	getAvailableOperators(BTGOperandModel leftOperand) Provides information about possible types for the operator than is used to create an expression for some existing rule given left operand type.
java.util.Collection<java.lang.Class<? extends BTGOperandModel>>	getAvailableRightOperands(BTGOperandModel leftOperand, java.lang.String operatorType) Provides information about possible types for the right operand than is used to create an expression for some existing rule given left operand type and operator type.
BTGConditionModel	updateExpression(BTGExpressionModel existingExpression, BTGOperandModel updatedLeftOperand, java.lang.String updatedOperator, BTGOperandModel updatedRightOperand) Updates an existing BTG expression.

Method Detail

getAvailableLeftOperandTypes

java.util.Collection<java.lang.Class<? extends BTGOperandModel>> getAvailableLeftOperandTypes(BTGRuleType ruleType)

Provides information about possible types for the left operand than is used to create an expression for some existing rule.

Parameters:

ruleType - Target ruleType for an expression that will use a left operand of the type defined by the returned collection.

Returns:

a collection of types available to use for creating left operand of an expression for the given rule. These types are subtypes of BTGOperand.

getAvailableOperators

java.util.Collection<java.lang.String> getAvailableOperators(BTGOperandModel leftOperand)
                                                      throws OperandValueProviderNotFoundException,
                                                             InvalidOperandException

Provides information about possible types for the operator than is used to create an expression for some existing rule given left operand type.

Parameters:

leftOperand - the left operand of the expression.

Returns:

a collection of types available to use for creating operator of an expression for the given rule. These types are subtypes of BTGOperator.

Throws:

OperandValueProviderNotFoundException

InvalidOperandException

getAvailableRightOperands

java.util.Collection<java.lang.Class<? extends BTGOperandModel>> getAvailableRightOperands(BTGOperandModel leftOperand,
                                                                                           java.lang.String operatorType)
                                                                                    throws InvalidOperandException

Provides information about possible types for the right operand than is used to create an expression for some existing rule given left operand type and operator type.

Parameters:

leftOperand - the left operand of the expression.

operatorType - a type of the operator of the expression.

Returns:

a collection of types available to use for creating right operand of an expression for the given rule. These types are subtypes of BTGOperand.

Throws:

InvalidOperandException

createExpression

BTGConditionModel createExpression(BTGOperandModel leftOperand,
                                   BTGOperatorModel operator,
                                   BTGOperandModel rightOperand,
                                   CatalogVersionModel catalogVersion)

Creates a new BTG expression. It does NOT save newly created expression to the database, so modelService.save(...) is required after using this method.

Parameters:

leftOperand - left operand of the expression

operator - operator of the expression

rightOperand - right operand of the expression

catalogVersion - CatalogVersion for the operator

Returns:

BTGExpressionModel. The model is not saved to the database.

updateExpression

BTGConditionModel updateExpression(BTGExpressionModel existingExpression,
                                   BTGOperandModel updatedLeftOperand,
                                   java.lang.String updatedOperator,
                                   BTGOperandModel updatedRightOperand)

Updates an existing BTG expression. It saves all changes to the database. Semantics of the "update" is following: If an updated operand represents different model instance than the operand in existingExpression, updated operand becomes a part of the existingExpression and then the old operand is removed from the database. If updated operand represents the same model instance as the operand in existingExpression (same PK), model data is just saved and no new instance is /stored to/removed from/ database. Operator is always updated "in place" i.e. no instance is created/removed.

Parameters:

existingExpression - expression to be updated

updatedLeftOperand - left operand of the expression

updatedOperator - operator of the expression

updatedRightOperand - right operand of the expression

Returns:

BTGExpressionModel. The model is not saved to the database.

createOperator

BTGOperatorModel createOperator(java.lang.String operatorString,
                                CatalogVersionModel catalogVersion)

Creates an operator

Parameters:

operatorString - defines the operator

catalogVersion - CatalogVersion for the operator

Returns:

BTGOperatorModel. The model is not saved to the database.