Package com.broadleafcommerce.metadata.dsl.core.extension.conditionals

Interface LogicalConditional<C extends LogicalConditional<C>>

All Superinterfaces:

Conditional<C>, Copyable<C>

All Known Implementing Classes:

DefaultLogicalConditional

public interface LogicalConditional<C extends LogicalConditional<C>>
extends Conditional<C>

An extension of Conditional that is used for performing logical operations on a set of conditionals.

For example, a conditional that is a match when only one of two conditionals must match:

 Conditionals.or(
         Conditionals.when("type").equalTo("PRODUCT"),
         Conditionals.when("type").equalTo("VARIANT"))
 

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogicalConditional.LogicalOperators

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE

Method Summary

Modifier and Type	Method	Description
default C	and()	Define the operator as LogicalConditional.LogicalOperators.AND.
default C	clearConditionals()	Clears the current conditions on this conditional.
default C	conditional(Conditional<?>... conditionals)	Adds one or more conditions to this conditional.
default C	conditionals(List<Conditional<?>> conditionals)	Adds one or more conditions to this conditional.
List<Conditional<?>>	getConditionals()
String	getOperator()
default String	getType()	The type of conditional.
default C	not()	Define the operator as LogicalConditional.LogicalOperators.NOT.
default C	operator(String operator)	Define the operator for this conditional.
default C	or()	Define the operator as LogicalConditional.LogicalOperators.OR.
void	setConditionals(List<Conditional<?>> conditionals)
void	setOperator(String operator)

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Conditional

self

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Field Detail

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

getType

default String getType()

Description copied from interface: Conditional

The type of conditional. This is used to distinguish different types of conditionals.

Specified by:

getType in interface Conditional<C extends LogicalConditional<C>>

Returns:

the type

getOperator

String getOperator()

getConditionals

List<Conditional<?>> getConditionals()

setOperator

void setOperator(String operator)

setConditionals

void setConditionals(List<Conditional<?>> conditionals)

operator

default C operator(String operator)

Define the operator for this conditional.

Parameters:

operator - the operator

Returns:

this

and

default C and()

Define the operator as LogicalConditional.LogicalOperators.AND.

Returns:

this

or

default C or()

Define the operator as LogicalConditional.LogicalOperators.OR.

Returns:

this

not

default C not()

Define the operator as LogicalConditional.LogicalOperators.NOT.

Returns:

this

conditional

default C conditional(Conditional<?>... conditionals)

Adds one or more conditions to this conditional.

Parameters:

conditionals - the conditional(s)

Returns:

this

conditionals

default C conditionals(List<Conditional<?>> conditionals)

Adds one or more conditions to this conditional.

Parameters:

conditionals - the conditional(s)

Returns:

this

clearConditionals

default C clearConditionals()

Clears the current conditions on this conditional.

Returns:

this