Package overit.geocallapp.wfm.bundler.bl.configuration.bundling.rule

Class BundlingRule

java.lang.Object

overit.geocallapp.wfm.bundler.bl.configuration.bundling.rule.BundlingRule

All Implemented Interfaces:

Serializable, Comparable<BundlingRule>

public class BundlingRule
extends Object
implements Serializable, Comparable<BundlingRule>

Object bean that contains the main information of the rule used to create a Bundle. It consists of:

• an header BOBundlingRuleHeader that contains the common characteristics of the rule
• a list of BOBundlingRuleFilter representing the links between the rule and the associated work order filters
• a list of BOBundlingRuleOrdering representing the links between the rule and the associated orderings

Since:

10.1

See Also:

• Serialized Form

GCApi:

bo

Constructor Summary

Constructors

Constructor	Description
BundlingRule()	Instantiates a new bundling rule.

Method Summary

Modifier and Type	Method	Description
int	compareTo(BundlingRule bundlingRule)	Compares the current bundling rule to the given one.
List<Long>	getBundleOperationOrderings()	Returns the list of the bundle operation ordering ids, sorted by priority.
BOBundlingRuleHeader	getHeader()	Returns the BOBundlingRuleHeader of the rule.
Long	getId()	Returns the bundling rule id, taking it from the BOBundlingRuleHeader .
List<BOBundlingRuleOrdering>	getOrderings()	Returns the list of the BOBundlingRuleOrdering associated to the rule.
List<BOBundlingRuleFilter>	getSelectionFilters()	Returns the list of BOBundlingRuleFilters associated to the rule.
List<Long>	getWorkOrderFilters()	Returns the work order filters.
static BundlingRule	makeFallbackBundlingRule()	Creates a fallback bundling rule used as backup when no other rules are applicable.
void	setHeader(BOBundlingRuleHeader header)	Sets the BOBundlingRuleHeader of the rule.
void	setOrderings(List<BOBundlingRuleOrdering> orderings)	Sets the list of the BOBundlingRuleOrdering associated to the rule.
void	setSelectionFilters(List<BOBundlingRuleFilter> selectionFilters)	Sets the list of BOBundlingRuleFilters associated to the rule.

Methods inherited from class java.lang.Object

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

Constructor Details

BundlingRule

public BundlingRule()

Instantiates a new bundling rule.

Method Details

makeFallbackBundlingRule

public static BundlingRule makeFallbackBundlingRule()

Creates a fallback bundling rule used as backup when no other rules are applicable. This rule ensures bundling operations can proceed with basic criteria when user-defined rules cannot be matched or executed.

Returns:

a BundlingRule with fallback configuration

getHeader

public BOBundlingRuleHeader getHeader()

Returns the BOBundlingRuleHeader of the rule.

Returns:

the BOBundlingRuleHeader

setHeader

public void setHeader(BOBundlingRuleHeader header)

Sets the BOBundlingRuleHeader of the rule.

Parameters:

header - the BOBundlingRuleHeader

getSelectionFilters

public List<BOBundlingRuleFilter> getSelectionFilters()

Returns the list of BOBundlingRuleFilters associated to the rule.

Returns:

a list of BOBundlingRuleFilters

See Also:

• BOBundlingRuleFilter

setSelectionFilters

public void setSelectionFilters(List<BOBundlingRuleFilter> selectionFilters)

Sets the list of BOBundlingRuleFilters associated to the rule.

Parameters:

selectionFilters - the list of BOBundlingRuleFilters

getOrderings

public List<BOBundlingRuleOrdering> getOrderings()

Returns the list of the BOBundlingRuleOrdering associated to the rule.

Returns:

a list of BOBundlingRuleOrdering

See Also:

• BOBundlingRuleOrdering

setOrderings

public void setOrderings(List<BOBundlingRuleOrdering> orderings)

Sets the list of the BOBundlingRuleOrdering associated to the rule.

Parameters:

orderings - the list of BOBundlingRuleOrdering

getBundleOperationOrderings

public List<Long> getBundleOperationOrderings()

Returns the list of the bundle operation ordering ids, sorted by priority.

Returns:

the list of BOBundleOperationOrdering ids sorted by priority

getWorkOrderFilters

public List<Long> getWorkOrderFilters()

Returns the work order filters.

Returns:

a list of long elements of type Long

See Also:

• Long

getId

public Long getId()

Returns the bundling rule id, taking it from the BOBundlingRuleHeader .

Returns:

the bundling rule id

compareTo

public int compareTo(BundlingRule bundlingRule)

Compares the current bundling rule to the given one.

Specified by:

compareTo in interface Comparable<BundlingRule>

Parameters:

bundlingRule - the given bundling rule that needs to be compared with the current

Returns:

a negative integer, zero, or a positive integer as the current bundling rule header has a priority that is less than, equal to, or greater than the given one.