Package overit.geocallapp.wfm.bundler.bl

Class Bundle

java.lang.Object

overit.geocall.model.DynO

overit.geocallapp.wfm.bundler.bl.Bundle

All Implemented Interfaces:

ConstraintValidator<DynO.Valid,DynO>, Serializable, overit.geocall.timezone.model.TimeZoned

public class Bundle
extends DynO
implements Serializable

An aggregator of multiple work order operations which allows to manage them as a single entity during the scheduling process.
It consists of:

• an header BOBundleHeader that contains the common characteristics of the bundle
• a list of BOBundleOperation which represents the links between the entity and the related work order operation

It also contains some other useful information such as:

• a list of BOBundleSkill that contains the skill needed by the bundle
• a list of BOBundleSkillDivision that contains the skill division needed by the bundle

Since:

10.1

See Also:

• Serialized Form

GCApi:

bo

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.model.DynO

DynO.SpanFields, DynO.SpanTable, DynO.Valid

Constructor Summary

Constructors

Constructor	Description
Bundle()	Instantiates a new bundle.

Method Summary

Modifier and Type	Method	Description
boolean	addOperation(BOBundleOperation bundleOperation)	Adds an operation to the bundle operations list.
boolean	addSkill(BOBundleSkill bundleSkill)	Adds a bundle skill.
boolean	addSkillDivision(BOBundleSkillDivision bundleSkillDivision)	Adds a bundle skill division.
BOBundleOperation	getActiveOperationByWorkOrderOperationId(Long woId)	Returns the active BOBundleOperation related to the given work order operation id.
List<BOBundleOperation>	getActiveOperations()	Returns the bundle operations that are in an active state.
List<Long>	getActiveWorkOrderOperationIds()	Returns the id of every work order operation related the current bundle that is not in BOBundleOperationStatus.Values.CLOSED or BOBundleOperationStatus.Values.CANCELLED state.
BOBundleCriterion	getCriterion()	Returns the bundle criterion.
BOBundleHeader	getHeader()	Returns the bundle header.
Long	getId()	Returns the id of the BOBundleHeader.
List<BOBundleOperation>	getNotCancelledOperations()	Returns the bundle operations that are not cancelled.
List<Long>	getNotCancelledWorkOrderOperationIds()	Returns the ids of all the work order operation related to the current bundle and not in BOBundleOperationStatus.Values.CANCELLED state.
BOBundleOperation	getOperationById(Long id)	Returns the BOBundleOperation related the given id.
List<Long>	getOperationIds()	Returns the ids of the BOBundleOperation.
List<BOBundleOperation>	getOperations()	Returns the bundle operations.
AggregateBundleRequirement	getRequirements()	Returns the aggregated bundle requirements.
Optional<BOBundleSkill>	getSkillById(Long id)	Returns the BOBundleSkill related the given id.
Optional<BOBundleSkill>	getSkillBySkillId(Long skillId)	Returns the BOBundleSkill related to the given {skill id.
Optional<BOBundleSkillDivision>	getSkillDivisionById(Long id)	Returns the BOBundleSkillDivision related the given id.
Optional<BOBundleSkillDivision>	getSkillDivisionBySkillDivisionId(Long skillDivisionId)	Returns the BOBundleSkillDivision related to the given skill division id.
List<BOBundleSkillDivision>	getSkillDivisions()	Returns the bundle skill divisions.
List<BOBundleSkill>	getSkills()	Returns the list of bundle skills.
List<BOBundleOperation>	getSortedNotCancelledOperations()	Returns the sorted bundle operations that are not in a cancelled state.
List<Long>	getWorkOrderOperationsIds()	Returns the list of work order operation ids that are related to the current Bundle.
void	removeAllSkillDivisions()	Removes the all skill divisions.
void	removeAllSkills()	Removes the all skills.
boolean	removeSkill(Long bundleSkillId)	Removes a bundle skill.
boolean	removeSkillDivision(Long bundleSkillDivisionId)	Removes a bundle skill division.
void	setCriterion(BOBundleCriterion criterion)	Sets the bundle criterion.
void	setHeader(BOBundleHeader header)	Sets the bundle header.
void	setOperations(List<BOBundleOperation> operations)	Sets the list of bundle operations.
void	setRequirements(AggregateBundleRequirement requirements)	Sets the aggregated bundle requirements.
void	setSkillDivisions(List<BOBundleSkillDivision> skillDivisions)	Sets the bundle skill divisions.
void	setSkills(List<BOBundleSkill> skills)	Sets the list of bundle skills.

Methods inherited from class overit.geocall.model.DynO

addExtension, extract, extract, fields, from, from, getCriteria, getCriteriaNotExploded, getExtension, getFakeFilter, getUnknownAttributes, getUnknownCriteria, getVariant, getZone, insert, insert, isValid, make, removeCriteria, removeExtensionAttribute, setCriteria, setCriteriaNotExploded, setExtension, setFakeFilter, setUnknownAttributes, setUnknownCriteria, setVariant, setZone, toFlatMap, toFlatMap, toMap, toMap, toString, update, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.validation.ConstraintValidator

initialize

Methods inherited from interface overit.geocall.timezone.model.TimeZoned

hasZone

Constructor Details

Bundle

public Bundle()

Instantiates a new bundle.

Method Details

getHeader

public BOBundleHeader getHeader()

Returns the bundle header.

Returns:

the header

See Also:

• BOBundleHeader

setHeader

public void setHeader(BOBundleHeader header)

Sets the bundle header.

Parameters:

header - the BOBundleHeader

See Also:

• BOBundleHeader

getOperations

public List<BOBundleOperation> getOperations()

Returns the bundle operations.

Returns:

a list of BOBundleOperation

See Also:

• BOBundleOperation

setOperations

public void setOperations(List<BOBundleOperation> operations)

Sets the list of bundle operations.

Parameters:

operations - the given list of BOBundleOperation

See Also:

• BOBundleOperation

addOperation

public boolean addOperation(BOBundleOperation bundleOperation)

Adds an operation to the bundle operations list.

Parameters:

bundleOperation - the bundle operation to add

Returns:

true if the BOBundleOperation is added to the operation list

getSkills

public List<BOBundleSkill> getSkills()

Returns the list of bundle skills.

Returns:

a list of BOBundleSkills

See Also:

• BOBundleSkill

getSkillById

public Optional<BOBundleSkill> getSkillById(Long id)

Returns the BOBundleSkill related the given id.

Parameters:

id - the needed BOBundleSkill id

Returns:

the corresponding BOBundleSkill

getSkillBySkillId

public Optional<BOBundleSkill> getSkillBySkillId(Long skillId)

Returns the BOBundleSkill related to the given {skill id.

Parameters:

skillId - the {skill id

Returns:

the corresponding BOBundleSkill

setSkills

public void setSkills(List<BOBundleSkill> skills)

Sets the list of bundle skills.

Parameters:

skills - the given list of BOBundleSkill

See Also:

• BOBundleSkill

addSkill

public boolean addSkill(BOBundleSkill bundleSkill)

Adds a bundle skill.

Parameters:

bundleSkill - the bundle skill to add

Returns:

true if the BOBundleSkill is added to the skill list

removeSkill

public boolean removeSkill(Long bundleSkillId)

Removes a bundle skill.

Parameters:

bundleSkillId - the identifier of the bundle skill to remove

Returns:

true if the BOBundleSkill is removed from the skill list

removeAllSkills

public void removeAllSkills()

Removes the all skills.

getSkillDivisions

public List<BOBundleSkillDivision> getSkillDivisions()

Returns the bundle skill divisions.

Returns:

a list of BOBundleSkillDivision

See Also:

• BOBundleSkillDivision

getSkillDivisionById

public Optional<BOBundleSkillDivision> getSkillDivisionById(Long id)

Returns the BOBundleSkillDivision related the given id.

Parameters:

id - the needed BOBundleSkillDivision id

Returns:

the corresponding BOBundleSkillDivision

getSkillDivisionBySkillDivisionId

public Optional<BOBundleSkillDivision> getSkillDivisionBySkillDivisionId(Long skillDivisionId)

Returns the BOBundleSkillDivision related to the given skill division id.

Parameters:

skillDivisionId - the skill division id

Returns:

the corresponding BOBundleSkillDivision

setSkillDivisions

public void setSkillDivisions(List<BOBundleSkillDivision> skillDivisions)

Sets the bundle skill divisions.

Parameters:

skillDivisions - the given list of BOBundleSkillDivision

See Also:

• BOBundleSkillDivision

addSkillDivision

public boolean addSkillDivision(BOBundleSkillDivision bundleSkillDivision)

Adds a bundle skill division.

Parameters:

bundleSkillDivision - the bundle skill division to add

Returns:

true if the BOBundleSkillDivision is added to the skill division list

removeSkillDivision

public boolean removeSkillDivision(Long bundleSkillDivisionId)

Removes a bundle skill division.

Parameters:

bundleSkillDivisionId - the identifier of the bundle skill division to remove

Returns:

true if the BOBundleSkillDivision is removed from the skill division list

removeAllSkillDivisions

public void removeAllSkillDivisions()

Removes the all skill divisions.

getCriterion

public BOBundleCriterion getCriterion()

Returns the bundle criterion.

Returns:

the criterion

See Also:

• BOBundleCriterion

setCriterion

public void setCriterion(BOBundleCriterion criterion)

Sets the bundle criterion.

Parameters:

criterion - the BOBundleCriterion

See Also:

• BOBundleCriterion

getId

public Long getId()

Returns the id of the BOBundleHeader.

Returns:

the BOBundleHeader id

getOperationIds

public List<Long> getOperationIds()

Returns the ids of the BOBundleOperation.

Returns:

the BOBundleOperation ids

getOperationById

public BOBundleOperation getOperationById(Long id)

Returns the BOBundleOperation related the given id.

Parameters:

id - the needed BOBundleOperation id

Returns:

the corresponding BOBundleOperation, null if no such BOBundleOperation exists

getActiveOperationByWorkOrderOperationId

public BOBundleOperation getActiveOperationByWorkOrderOperationId(Long woId)

Returns the active BOBundleOperation related to the given work order operation id.

Parameters:

woId - the work order operation id

Returns:

the corresponding BOBundleOperation, null if no such BOBundleOperation exists

getActiveOperations

public List<BOBundleOperation> getActiveOperations()

Returns the bundle operations that are in an active state.

Returns:

a list of active BOBundleOperation

getSortedNotCancelledOperations

public List<BOBundleOperation> getSortedNotCancelledOperations()

Returns the sorted bundle operations that are not in a cancelled state.

Returns:

a list of not cancelled BOBundleOperation

getNotCancelledOperations

public List<BOBundleOperation> getNotCancelledOperations()

Returns the bundle operations that are not cancelled.

Returns:

a list of not cancelled BOBundleOperation

getWorkOrderOperationsIds

public List<Long> getWorkOrderOperationsIds()

Returns the list of work order operation ids that are related to the current Bundle.

Returns:

a list of work order operation ids

getActiveWorkOrderOperationIds

public List<Long> getActiveWorkOrderOperationIds()

Returns the id of every work order operation related the current bundle that is not in BOBundleOperationStatus.Values.CLOSED or BOBundleOperationStatus.Values.CANCELLED state.

Returns:

a list of work order operation ids

getNotCancelledWorkOrderOperationIds

public List<Long> getNotCancelledWorkOrderOperationIds()

Returns the ids of all the work order operation related to the current bundle and not in BOBundleOperationStatus.Values.CANCELLED state.

Returns:

a list of work order operation ids

getRequirements

public AggregateBundleRequirement getRequirements()

Returns the aggregated bundle requirements. This includes mandatory, preferred, and excluded resources and teams for the bundle.

Returns:

the AggregateBundleRequirement

See Also:

• AggregateBundleRequirement

setRequirements

public void setRequirements(AggregateBundleRequirement requirements)

Sets the aggregated bundle requirements.

Parameters:

requirements - the AggregateBundleRequirement

See Also:

• AggregateBundleRequirement