Package overit.geocallapp.wfm.mobileforms.bl.instance.task

Class BTDataCollectionSheetInstanceCloseSchedulingResourceSheet

java.lang.Object

overit.geocall.bl.BusinessTask<CheckableEvent<Long,Void>>

overit.geocallapp.utilities.core.bl.common.check.checkable.task.AbstractCheckableBusinessTask<Long,Void>

overit.geocallapp.utilities.core.bl.common.check.checkable.task.ValidExecutionAbstractCheckableBusinessTask<Long,Void>

overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollectionCheckable<Long,Void>

overit.geocallapp.wfm.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceCloseSchedulingResourceSheet

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceCloseSchedulingResourceSheetEvent.class)
public class BTDataCollectionSheetInstanceCloseSchedulingResourceSheet
extends BTDataCollectionCheckable<Long,Void>

Business task in order to close a DataCollectionSheetInstance.
When the DataCollectionSheetInstanceCloseSchedulingResourceSheetEvent is launched the BT notices the call and closes the DataCollectionSheetInstance basing on the event's input.

Permission:

• DataCollectionPermission.FSM_DATACOLLECTION_SHEET_EDIT

Errors:

• Codes.DATACOLLECTION_SHEET_MUST_BE_IN_FIXED_STATE
• Codes.DATACOLLECTION_SHEET_MUST_BE_ASSOCIATE_TO_SCHED_USER

Visibility:

• scheduling users that belong to the same current user's operation center
• sheets that belong to the same current user's operation center

Since:

12.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceCloseSchedulingResourceSheet()

Method Summary

Modifier and Type	Method	Description
protected void	checkCanClose(BODataCollectionSheet sheet)	Checks whether the closing operation is permitted.
protected List<CheckerEvent<?>>	defineCheckerEvents(Long sheetId, PoolKit poolKit)	Defines the checker events.
protected Void	executeProcess(Long sheetId, PoolKit poolKit)	Closes the data collection sheet instance.
boolean	isValidExecution()	Checks whether the view sheet permission is activated or not.
protected BODataCollectionSheet	loadSheet(Long sheetId, PoolKit poolKit)	Loads the sheet.
protected DataCollectionSheetInstance	loadSheetInstance(Long sheetId, PoolKit poolKit)	Loads the sheet instance.

Methods inherited from class overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollectionCheckable

getException, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.check.checkable.task.ValidExecutionAbstractCheckableBusinessTask

body, checkValidExecution

Methods inherited from class overit.geocallapp.utilities.core.bl.common.check.checkable.task.AbstractCheckableBusinessTask

buildOutputCheckResult, launchCheckerEvents, throwExceptionIfNecessary, validate

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

BTDataCollectionSheetInstanceCloseSchedulingResourceSheet

public BTDataCollectionSheetInstanceCloseSchedulingResourceSheet()

Method Details

isValidExecution

public boolean isValidExecution()

Checks whether the view sheet permission is activated or not.

Specified by:

isValidExecution in interface ValidExecution

Overrides:

isValidExecution in class BTDataCollectionCheckable<Long,Void>

Returns:

true, if the view sheet permission is active, false otherwise

executeProcess

protected Void executeProcess(Long sheetId,
 PoolKit poolKit)
                       throws DAException,
DAValidateException

Closes the data collection sheet instance.

Specified by:

executeProcess in class AbstractCheckableBusinessTask<Long,Void>

Parameters:

sheetId - the sheet id

poolKit - the PoolKit

Returns:

the void

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkCanClose

protected void checkCanClose(BODataCollectionSheet sheet)
                      throws DAValidateException

Checks whether the closing operation is permitted.

Parameters:

sheet - the BODataCollectionSheet

Throws:

DAValidateException - the DA validate exception

loadSheet

protected BODataCollectionSheet loadSheet(Long sheetId,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Loads the sheet.

Parameters:

sheetId - the sheet id

poolKit - the PoolKit

Returns:

the BO data collection sheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

defineCheckerEvents

protected List<CheckerEvent<?>> defineCheckerEvents(Long sheetId,
 PoolKit poolKit)
                                             throws DAException,
DAValidateException

Defines the checker events.

Specified by:

defineCheckerEvents in class AbstractCheckableBusinessTask<Long,Void>

Parameters:

sheetId - the sheet id

poolKit - the PoolKit

Returns:

a list of checker event elements of type CheckerEvent

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

See Also:

• CheckerEvent

loadSheetInstance

protected DataCollectionSheetInstance loadSheetInstance(Long sheetId,
 PoolKit poolKit)
                                                 throws DAValidateException,
DAException

Loads the sheet instance.

Parameters:

sheetId - the sheet id

poolKit - the PoolKit

Returns:

the data collection sheet instance

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception