Package overit.geocallapp.wfm.core.bl.bundler.task

Class BTBundleWorkOrderOperationStateChange

java.lang.Object

overit.geocall.bl.BusinessTask<WorkOrderOperationStateChangeEvent>

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

overit.geocallapp.wfm.bundler.bl.task.BTBundler<WorkOrderOperationStateChangeEvent>

overit.geocallapp.wfm.core.bl.bundler.task.BTBundleWorkOrderOperationStateChange

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WorkOrderOperationStateChangeEvent.class)
public class BTBundleWorkOrderOperationStateChange
extends BTBundler<WorkOrderOperationStateChangeEvent>

Business task in order to change the state of the Bundle related to the given BOWorkOrderOperation, according to its state change.
When the WorkOrderOperationStateChangeEvent is launched the BT notices the call and changes the state of the related Bundle basing on the event's input.

Error Code:

• Codes.Bundler.RELATION_STATE_NOT_EDITABLE

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleWorkOrderOperationStateChange()

Method Summary

Modifier and Type	Method	Description
protected void	execute(WorkOrderOperationStateChangeEvent event, PoolKit poolKit)	If the given BOWorkOrderOperation is associated to an active Bundle, the state of the related BOBundleOperation is changed.
protected Long	getBundleOperationStatusFromOutcome(BOBundleOperation bundleOperation, BOWorkOrderOperation woOperation, PoolKit poolKit)	Searches for the valid status for the BOBundleOperation: when the given BOWorkOrderOperation is already associated to a BOAgendaOutcome, the only possible status value is BOBundleOperationStatus.Values.CLOSED.
protected List<Long>	getClosedWOOperationStates()	Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.CLOSED.
protected List<Long>	getInProgressWOOperationStates()	Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.IN_PROGRESS.
protected Long	getNewBundleOperationStatus(BOBundleOperation bundleOperation, PoolKit poolKit)	Returns the id of the BOBundleOperationStatus that corresponds to the status of the given BOWorkOrderOperation.
protected List<Long>	getPlannedWOOperationStates()	Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.PLANNED.
protected void	linkWorkOrderOperations(List<Long> woOperationIds, PoolKit poolKit)	Creates the new links for the remaining BOWorkOrderOperations of the given Bundle.
protected Bundle	loadBundle(Long workOrderOperationId, PoolKit poolKit)	Loads the active Bundle related to the given BOWorkOrderOperation id.
protected BOWorkOrderOperation	loadWorkOrderOperation(Long workOrderOperationId, PoolKit poolKit)	Loads the BOWorkOrderOperation from the given input.
protected List<BOWorkOrderOperation>	loadWorkOrderOperations(List<Long> ids, PoolKit poolKit)	Loads the list of related BOWorkOrderOperation from the given ids.
protected void	recalculateLinks(Bundle bundle, BOBundleOperation bundleOperation, PoolKit poolKit)	Recalculates the links between the BOWorkOrderOperations by unlinking all of them and relinking the ones remaining after removing the given one.
boolean	throwExceptionIfInvalid()	Controls whether an exception should be thrown when execution is invalid.
protected void	unlinkWorkOrderOperations(Bundle bundle, PoolKit poolKit)	Unlinks of the parent BOWorkOrderOperation from all its children.
protected Long	updateBundleOperationStatus(BOBundleOperation bundleOperation, PoolKit poolKit)	Updates the BOBundleOperation status by calling BundleOperationStatusUpdateEvent, only if the status change is permitted.
protected void	updateSchedulingLinks(Bundle bundle, Long unlinkingOperation, List<Long> remainingOperations, PoolKit poolKit)	Updates the relations between the existing active schedulings.

Methods inherited from class overit.geocallapp.wfm.bundler.bl.task.BTBundler

getException, isValidExecution

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

body, checkValidExecution, 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

BTBundleWorkOrderOperationStateChange

public BTBundleWorkOrderOperationStateChange()

Method Details

throwExceptionIfInvalid

public boolean throwExceptionIfInvalid()

Description copied from interface: ValidExecution

Controls whether an exception should be thrown when execution is invalid. This method allows implementing classes to specify their exception-throwing behavior when ValidExecution.isValidExecution() returns false. If this method returns true, callers should throw the exception returned by ValidExecution.getException().

Specified by:

throwExceptionIfInvalid in interface ValidExecution

Overrides:

throwExceptionIfInvalid in class BTBundler<WorkOrderOperationStateChangeEvent>

Returns:

true if an exception should be thrown for invalid execution, false otherwise

execute

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

If the given BOWorkOrderOperation is associated to an active Bundle, the state of the related BOBundleOperation is changed.

Specified by:

execute in class ValidExecutionBusinessTask<WorkOrderOperationStateChangeEvent>

Parameters:

event - the WorkOrderOperationStateChangeEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadBundle

protected Bundle loadBundle(Long workOrderOperationId,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Loads the active Bundle related to the given BOWorkOrderOperation id.

Parameters:

workOrderOperationId - the BOWorkOrderOperation id

poolKit - the PoolKit

Returns:

the related Bundle

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateBundleOperationStatus

protected Long updateBundleOperationStatus(BOBundleOperation bundleOperation,
 PoolKit poolKit)
                                    throws DAValidateException,
DAException

Updates the BOBundleOperation status by calling BundleOperationStatusUpdateEvent, only if the status change is permitted.

Parameters:

bundleOperation - BOBundleOperation

poolKit - the PoolKit

Returns:

the value of the new calculated BOBundleOperationStatus for the current bundle operation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getNewBundleOperationStatus

protected Long getNewBundleOperationStatus(BOBundleOperation bundleOperation,
 PoolKit poolKit)
                                    throws DAValidateException,
DAException

Returns the id of the BOBundleOperationStatus that corresponds to the status of the given BOWorkOrderOperation.

Parameters:

bundleOperation - the BOBundleOperation

poolKit - the PoolKit

Returns:

the new value of BOBundleOperation status

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getBundleOperationStatusFromOutcome

protected Long getBundleOperationStatusFromOutcome(BOBundleOperation bundleOperation,
 BOWorkOrderOperation woOperation,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

Searches for the valid status for the BOBundleOperation: when the given BOWorkOrderOperation is already associated to a BOAgendaOutcome, the only possible status value is BOBundleOperationStatus.Values.CLOSED. Otherwise the value BOBundleOperationStatus.Values.SCHEDULABLE is returned.

Parameters:

bundleOperation - the BOBundleOperation

woOperation - the given BOWorkOrderOperation

poolKit - the PoolKit

Returns:

the corresponding valid BOBundleOperationStatus value

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrderOperation

protected BOWorkOrderOperation loadWorkOrderOperation(Long workOrderOperationId,
 PoolKit poolKit)
                                               throws DAValidateException,
DAException

Loads the BOWorkOrderOperation from the given input.

Parameters:

workOrderOperationId - the BOWorkOrderOperation id

poolKit - the PoolKit

Returns:

the loaded BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getPlannedWOOperationStates

protected List<Long> getPlannedWOOperationStates()

Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.PLANNED.

Returns:

the list of planned BOWorkOrderOperationState ids.

getInProgressWOOperationStates

protected List<Long> getInProgressWOOperationStates()

Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.IN_PROGRESS.

Returns:

the list of planned BOWorkOrderOperationState ids.

getClosedWOOperationStates

protected List<Long> getClosedWOOperationStates()

Returns the list of BOWorkOrderOperationState that are valid in order to change the BOBundleOperation state to BOBundleOperationStatus.Values.CLOSED.

Returns:

the list of planned BOWorkOrderOperationState ids.

loadWorkOrderOperations

protected List<BOWorkOrderOperation> loadWorkOrderOperations(List<Long> ids,
 PoolKit poolKit)
                                                      throws DAValidateException,
DAException

Loads the list of related BOWorkOrderOperation from the given ids.

Parameters:

ids - list of needed BOWorkOrderOperation ids

poolKit - the PoolKit

Returns:

a list of needed BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

unlinkWorkOrderOperations

protected void unlinkWorkOrderOperations(Bundle bundle,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Unlinks of the parent BOWorkOrderOperation from all its children.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

linkWorkOrderOperations

protected void linkWorkOrderOperations(List<Long> woOperationIds,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Creates the new links for the remaining BOWorkOrderOperations of the given Bundle.

Parameters:

woOperationIds - the wo operation ids

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

recalculateLinks

protected void recalculateLinks(Bundle bundle,
 BOBundleOperation bundleOperation,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Recalculates the links between the BOWorkOrderOperations by unlinking all of them and relinking the ones remaining after removing the given one.

Parameters:

bundle - the current Bundle

bundleOperation - the current BOBundleOperation related to the BOWorkOrderOperation to remove

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateSchedulingLinks

protected void updateSchedulingLinks(Bundle bundle,
 Long unlinkingOperation,
 List<Long> remainingOperations,
 PoolKit poolKit)
                              throws DAValidateException,
DAException

Updates the relations between the existing active schedulings.

Parameters:

bundle - the current Bundle

unlinkingOperation - the id of the BOWorkOrderOperation to unlink

remainingOperations - list of all the BOWorkOrderOperation that will remain linked

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception