Package overit.geocallapp.docshare.documents.bl.sharedresource.file.task

Class BTMainVersionFileLoad

java.lang.Object

overit.geocall.bl.BusinessTask<MainVersionFileLoadEvent>

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

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

overit.geocallapp.docshare.documents.bl.sharedresource.file.task.BTMainVersionFileLoad

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(MainVersionFileLoadEvent.class)
public class BTMainVersionFileLoad
extends ValidPermissionBusinessTask<MainVersionFileLoadEvent>

Business task in order to load the main version of a BOFile, which corresponds to the currently active one or the latest one if the active one is not available.
When the MainVersionFileLoadEvent is launched the BT notices the call and loads the BOFile basing on the event's input.

Error Code:

• Codes.NOT_FOUND

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

Method Summary

Modifier and Type	Method	Description
protected void	execute(MainVersionFileLoadEvent event, PoolKit poolKit)	Writes the loaded file into the event journal.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected BOFile	loadMainVersion(MainVersionFileLoadEvent event, PoolKit poolKit)	Loads the main version of the file.
protected List<BOFile>	searchFiles(FileSearchFilter filter, PoolKit poolKit)	Searches the files based on the given filter.

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

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

BTMainVersionFileLoad

public BTMainVersionFileLoad()

Method Details

execute

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

Writes the loaded file into the event journal.

Specified by:

execute in class ValidExecutionBusinessTask<MainVersionFileLoadEvent>

Parameters:

event - the MainVersionFileLoadEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadMainVersion

protected BOFile loadMainVersion(MainVersionFileLoadEvent event,
 PoolKit poolKit)
                          throws DAException,
DAValidateException

Loads the main version of the file. Specifically, it searches for the currently active version. If it is not available, it searches for the latest version even if it is not active because it is the only one available.

Parameters:

event - the MainVersionFileLoadEvent

poolKit - the PoolKit

Returns:

the BOFile

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

searchFiles

protected List<BOFile> searchFiles(FileSearchFilter filter,
 PoolKit poolKit)
                            throws DAException,
DAValidateException

Searches the files based on the given filter.

Parameters:

filter - the FileSearchFilter

poolKit - the PoolKit

Returns:

the list of BOFile

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

isValidExecution

public boolean isValidExecution()

Description copied from interface: ValidExecution

Determines whether the current state is valid for execution.

Returns:

true if execution is valid, false otherwise