Package overit.geocallapp.wfm.core.bl.permits.checker.task

Class BTPermitsIntersectionsChecker<I>

java.lang.Object

overit.geocall.bl.BusinessTask<CheckerEvent<I>>

overit.geocallapp.utilities.core.bl.common.check.checker.task.AbstractCheckerBusinessTask<I>

overit.geocallapp.utilities.core.bl.common.check.checker.task.ValidExecutionAbstractCheckerBusinessTask<I>

overit.geocallapp.wfm.core.bl.permits.checker.task.BTPermitsIntersectionsChecker<I>

Type Parameters:

I - the generic type

All Implemented Interfaces:

Serializable, Tool, ValidExecution

Direct Known Subclasses:

BTPermitsIntersectionsCristallizationChecker, BTPermitsIntersectionsModifyChecker, BTPermitsIntersectionsPasteChecker

public abstract class BTPermitsIntersectionsChecker<I>
extends ValidExecutionAbstractCheckerBusinessTask<I>

Generic business task for the permit checker entities.
Before executing its purpose, the task checks whether the permit module is active or not.

Error Code:

• Codes.DATACOLLECTION_MODULE_NOT_ACTIVE_OR_MISSING_PERMISSION

Since:

14.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTPermitsIntersectionsChecker()

Method Summary

Modifier and Type	Method	Description
protected void	addIssue(List<CheckIssue> checkIssues, Code code, CheckIssueLevel level, boolean userConfirmNecessary, Object... params)	Adds the issue.
protected void	checkAndAddIssues(PoolKit poolKit, Date schedulingActivityDate, Set<Long> woOperationIds, List<CheckIssue> issues)
protected void	checkAndAddIssues(PoolKit poolKit, Date schedulingActivityDate, Set<Long> woOperationIds, List<CheckIssue> issues, Map<Long,WorkOrderPermits> workOrderPermitsByOperation)
DAValidateException	getException()	Returns the exception that describes why execution is invalid.
protected Date	getSchedulingDate(Set<Long> schedulingIds, PoolKit poolKit)
protected Long	getWorkOrder(Long woOperationId, PoolKit poolKit)
protected String	getWorkOrderCode(PoolKit poolKit, Long workOrderId)
boolean	isValidExecution()	Checks whether the permit is activated or not.
boolean	throwExceptionIfInvalid()	Controls whether an exception should be thrown when execution is invalid.

Methods inherited from class overit.geocallapp.utilities.core.bl.common.check.checker.task.ValidExecutionAbstractCheckerBusinessTask

body, checkValidExecution

Methods inherited from class overit.geocallapp.utilities.core.bl.common.check.checker.task.AbstractCheckerBusinessTask

addCheckIssuesToCheckResult, computeCheckIssues, initCheckResult

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

BTPermitsIntersectionsChecker

public BTPermitsIntersectionsChecker()

Method Details

isValidExecution

public boolean isValidExecution()

Checks whether the permit is activated or not.

Returns:

true, if the data collection module is active, false otherwise

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().

Returns:

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

getException

public DAValidateException getException()

Description copied from interface: ValidExecution

Returns the exception that describes why execution is invalid. This method provides detailed information about validation failures when ValidExecution.isValidExecution() returns false. The returned exception can be thrown by callers if ValidExecution.throwExceptionIfInvalid() returns true.

Returns:

a DAValidateException describing the validation failure, or null if execution is valid or no specific exception is available

addIssue

protected void addIssue(List<CheckIssue> checkIssues,
 Code code,
 CheckIssueLevel level,
 boolean userConfirmNecessary,
 Object... params)

Adds the issue.

Parameters:

checkIssues - list of check issue elements

code - the code

level - the level

params - the params

getWorkOrder

protected Long getWorkOrder(Long woOperationId,
 PoolKit poolKit)
                     throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

checkAndAddIssues

protected void checkAndAddIssues(PoolKit poolKit,
 Date schedulingActivityDate,
 Set<Long> woOperationIds,
 List<CheckIssue> issues)
                          throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

checkAndAddIssues

protected void checkAndAddIssues(PoolKit poolKit,
 Date schedulingActivityDate,
 Set<Long> woOperationIds,
 List<CheckIssue> issues,
 Map<Long,WorkOrderPermits> workOrderPermitsByOperation)
                          throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getWorkOrderCode

protected String getWorkOrderCode(PoolKit poolKit,
 Long workOrderId)
                           throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getSchedulingDate

protected Date getSchedulingDate(Set<Long> schedulingIds,
 PoolKit poolKit)
                          throws DAException,
DAValidateException

Throws:

DAException

DAValidateException