Package overit.geocallapp.wfm.inventory.bl.warehouse.material.scheduling.task

Class BTWarehouseMaterialInsertFromScheduling

java.lang.Object

overit.geocall.bl.BusinessTask<WarehouseMaterialInsertFromSchedulingEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<WarehouseMaterialInsertFromSchedulingEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<WarehouseMaterialInsertFromSchedulingEvent>

overit.geocallapp.wfm.inventory.bl.task.BTInventoryManagement<WarehouseMaterialInsertFromSchedulingEvent>

overit.geocallapp.wfm.inventory.bl.warehouse.material.scheduling.task.BTWarehouseMaterialInsertFromScheduling

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WarehouseMaterialInsertFromSchedulingEvent.class)
public class BTWarehouseMaterialInsertFromScheduling
extends BTInventoryManagement<WarehouseMaterialInsertFromSchedulingEvent>

Business task in order to insert the missing BOWarehouseMaterial relations for all the materials that are scheduled in a Codes.WorkOrderOperation.
When the WarehouseMaterialInsertFromSchedulingEvent is launched the BT notices the call and performs the following actions:

• loads all the scheduled materials associated to any Codes.WorkOrderOperation that is BOWorkOrderOperationState.Values.SCHEDULED or BOWorkOrderOperationState.Values.FIXED
• starting from the intervention user, checks if the material is managed in stock and if it is associated to a valid central warehouse
• checks whether is necessary to insert a new BOWarehouseMaterial relation for every scheduled material

Since:

14.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

LOG

Constructor Summary

Constructors

Constructor	Description
BTWarehouseMaterialInsertFromScheduling()

Method Summary

Modifier and Type	Method	Description
protected void	checkWarehouseMaterialInsertion(List<BOWorkOrderOperation> workOrderOperations, PoolKit poolKit)	Checks whether is necessary to insert a new BOWarehouseMaterial relation for every material that was scheduled in one of the given BOWorkOrderOperation.
protected void	execute(WarehouseMaterialInsertFromSchedulingEvent event, PoolKit poolKit)	Loads all the scheduled materials associated to any Codes.WorkOrderOperation that is BOWorkOrderOperationState.Values.SCHEDULED or BOWorkOrderOperationState.Values.FIXED and that was scheduled during the indicated interval.
protected Long	getInterventionUser(BOWorkOrderOperation operation, PoolKit poolKit)	Returns the Intervention scheduling user starting from the given BOWorkOrderOperation.
protected LogHelper	getLogHelper()
protected LogMessageHelper	getLogMessage()
protected Long	getSchedulingUserCentralWarehouse(BOWorkOrderOperation woOperation, PoolKit poolKit)	Returns the id of the preferred BOCentralWarehouse associated to the scheduling user of the given BOWorkOrderOperation.
protected BOWarehouseMaterial	insertWarehouseMaterialRelation(BOMaterial material, Long centralWarehouse, PoolKit poolKit)	Inserts a new BOWarehouseMaterial starting from the BOMaterial id and the given BOCentralWarehouse id.
boolean	isValidExecution()	Checks if the execution is valid.
protected BOMaterial	loadMaterial(Long materialId, PoolKit poolKit)	Loads the material by the given id.
protected Long	loadPreferredCentralWarehouse(BOMobileWarehouse mobileWarehouse, PoolKit poolKit)	Loads the id of the preferred BOCentralWarehouse for the given BOMobileWarehouse.
protected BOMobileWarehouse	loadUserMobileWarehouse(Long schedulingUser, PoolKit poolKit)	Loads the BOMobileWarehouse associated to the given scheduling user id.
protected BOWarehouseMaterial	loadWarehouseMaterialRelation(Long materialId, Long centralWarehouse, PoolKit poolKit)	Loads the BOWarehouseMaterial relation starting from the BOMaterial id and the given BOCentralWarehouse id.
protected List<BOWorkOrderOperationMaterial>	loadWorkOrderOperationMaterials(Long workOrderOperationId, PoolKit poolKit)	Loads the BOWorkOrderOperationMaterial relations.
protected List<BOWorkOrderOperation>	loadWorkOrderOperationsByState(int schedulingDaysFrom, int schedulingDaysTo, PoolKit poolKit)	Loads the BOWorkOrderOperation by the given state, filtering them with the scheduling time interval defined in the configuration.
protected void	openLog()

Methods inherited from class overit.geocallapp.wfm.inventory.bl.task.BTInventoryManagement

checkValidExecution

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

getException, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, getEvent

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Constructor Details

BTWarehouseMaterialInsertFromScheduling

public BTWarehouseMaterialInsertFromScheduling()

Method Details

execute

protected void execute(WarehouseMaterialInsertFromSchedulingEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Loads all the scheduled materials associated to any Codes.WorkOrderOperation that is BOWorkOrderOperationState.Values.SCHEDULED or BOWorkOrderOperationState.Values.FIXED and that was scheduled during the indicated interval. After that, it checks whether all the related scheduled materials have a BOWarehouseMaterial relation. If the relation is not present, it inserts it.

Specified by:

execute in class ValidExecutionBusinessTask<WarehouseMaterialInsertFromSchedulingEvent>

Parameters:

event - the WarehouseMaterialInsertFromSchedulingEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkWarehouseMaterialInsertion

protected void checkWarehouseMaterialInsertion(List<BOWorkOrderOperation> workOrderOperations,
 PoolKit poolKit)
                                        throws DAValidateException,
DAException

Checks whether is necessary to insert a new BOWarehouseMaterial relation for every material that was scheduled in one of the given BOWorkOrderOperation.

Parameters:

workOrderOperations - list of BOWorkOrderOperation

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrderOperationsByState

protected List<BOWorkOrderOperation> loadWorkOrderOperationsByState(int schedulingDaysFrom,
 int schedulingDaysTo,
 PoolKit poolKit)
                                                             throws DAValidateException,
DAException

Loads the BOWorkOrderOperation by the given state, filtering them with the scheduling time interval defined in the configuration.

Parameters:

schedulingDaysFrom - the number of days preceding the scheduling date

schedulingDaysTo - the number of days following the scheduling date

poolKit - the PoolKit

Returns:

a list of loaded BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrderOperationMaterials

protected List<BOWorkOrderOperationMaterial> loadWorkOrderOperationMaterials(Long workOrderOperationId,
 PoolKit poolKit)
                                                                      throws DAValidateException,
DAException

Loads the BOWorkOrderOperationMaterial relations.

Parameters:

workOrderOperationId - the BOWorkOrderOperation id

poolKit - the PoolKit

Returns:

a list of loaded BOWorkOrderOperationMaterial relations

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getInterventionUser

protected Long getInterventionUser(BOWorkOrderOperation operation,
 PoolKit poolKit)
                            throws DAValidateException,
DAException

Returns the Intervention scheduling user starting from the given BOWorkOrderOperation.

Parameters:

operation - the operation

poolKit - the pool kit

Returns:

the intervention user

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadUserMobileWarehouse

protected BOMobileWarehouse loadUserMobileWarehouse(Long schedulingUser,
 PoolKit poolKit)
                                             throws DAValidateException,
DAException

Loads the BOMobileWarehouse associated to the given scheduling user id.

Parameters:

schedulingUser - the scheduling user id

poolKit - the PoolKit

Returns:

the loaded BOMobileWarehouse

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadPreferredCentralWarehouse

protected Long loadPreferredCentralWarehouse(BOMobileWarehouse mobileWarehouse,
 PoolKit poolKit)
                                      throws DAValidateException,
DAException

Loads the id of the preferred BOCentralWarehouse for the given BOMobileWarehouse.

Parameters:

mobileWarehouse - the BOMobileWarehouse

poolKit - the PoolKit

Returns:

the id of the preferred BOCentralWarehouse

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSchedulingUserCentralWarehouse

protected Long getSchedulingUserCentralWarehouse(BOWorkOrderOperation woOperation,
 PoolKit poolKit)
                                          throws DAValidateException,
DAException

Returns the id of the preferred BOCentralWarehouse associated to the scheduling user of the given BOWorkOrderOperation.

Parameters:

woOperation - the BOWorkOrderOperation

poolKit - the PoolKit

Returns:

the scheduling user's central warehouse id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadMaterial

protected BOMaterial loadMaterial(Long materialId,
 PoolKit poolKit)
                           throws DAValidateException,
DAException

Loads the material by the given id.

Parameters:

materialId - the BOMaterial id

poolKit - the PoolKit

Returns:

the loaded BOMaterial

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWarehouseMaterialRelation

protected BOWarehouseMaterial loadWarehouseMaterialRelation(Long materialId,
 Long centralWarehouse,
 PoolKit poolKit)
                                                     throws DAValidateException,
DAException

Loads the BOWarehouseMaterial relation starting from the BOMaterial id and the given BOCentralWarehouse id.

Parameters:

materialId - the BOMaterial id

centralWarehouse - the BOCentralWarehouse id

poolKit - the PoolKit

Returns:

the loaded BOWarehouseMaterial relation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertWarehouseMaterialRelation

protected BOWarehouseMaterial insertWarehouseMaterialRelation(BOMaterial material,
 Long centralWarehouse,
 PoolKit poolKit)
                                                       throws DAValidateException,
DAException

Inserts a new BOWarehouseMaterial starting from the BOMaterial id and the given BOCentralWarehouse id.

Parameters:

material - the BOMaterial id

centralWarehouse - the BOCentralWarehouse id

poolKit - the PoolKit

Returns:

the inserted BOWarehouseMaterial relation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

isValidExecution

public boolean isValidExecution()

Checks if the execution is valid.

Returns:

true, if successful

openLog

protected void openLog()
                throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getLogHelper

protected LogHelper getLogHelper()

getLogMessage

protected LogMessageHelper getLogMessage()