agentgui.core.project.transfer

Interface ProjectExportController

All Known Implementing Classes:

DefaultProjectExportController

public interface ProjectExportController

This interface can be implemented to provide specialized project export controllers. It is highly recommended not to implement this interface yourself, but extend the provided class DefaultProjectExportController instead, which provides basic project export functionality and several callback functions to add own code.

Method Summary

Modifier and Type	Method and Description
void	exportProject(Project project, ProjectExportSettings projectExportSettings) Export project.
void	exportProject(Project project, ProjectExportSettings exportSettings, boolean showUserDialogs, boolean useConcurrentThread) Exports the current project using the provided ProjectExportSettings.
java.util.ArrayList<java.io.File>	getAdditionalSetupFiles(java.lang.String setupName) This method can be used to specify additional setup-related files, that should be considered when determining which files to include when exporting projects.
java.util.ArrayList<java.nio.file.Path>	getDefaultExcludeList() This method can be used to provide a list of files and folders that should be excluded from the export by default.
ProjectExportSettings	getProjectExportSettings(Project project) Gets the project export settings.
boolean	isExportSuccessful() Checks if the export was successfully finished
void	setMessageFailure(java.lang.String messageFailure) Sets the message for export failures.
void	setMessageSuccess(java.lang.String messageSuccess) Sets the message for an export success.

Method Detail

getProjectExportSettings

ProjectExportSettings getProjectExportSettings(Project project)

Gets the project export settings.

Returns:

the project export settings

exportProject

void exportProject(Project project,
                   ProjectExportSettings projectExportSettings)

Export project.

Parameters:

project - the project

projectExportSettings - the project export settings

exportProject

void exportProject(Project project,
                   ProjectExportSettings exportSettings,
                   boolean showUserDialogs,
                   boolean useConcurrentThread)

Exports the current project using the provided ProjectExportSettings.

Parameters:

the - project to be exported

exportSettings - The ProjectExportSettings

showUserDialogs - specifies if user dialogs are shown

useConcurrentThread - specifies if the project should be exported in a concurrent thread

isExportSuccessful

boolean isExportSuccessful()

Checks if the export was successfully finished

Returns:

true if successfully finished

setMessageSuccess

void setMessageSuccess(java.lang.String messageSuccess)

Sets the message for an export success.

Parameters:

messageSuccess - the new message success

setMessageFailure

void setMessageFailure(java.lang.String messageFailure)

Sets the message for export failures.

Parameters:

messageFailure - the new message failure

getAdditionalSetupFiles

java.util.ArrayList<java.io.File> getAdditionalSetupFiles(java.lang.String setupName)

This method can be used to specify additional setup-related files, that should be considered when determining which files to include when exporting projects.

Parameters:

setupName - the setup name

Returns:

the additional setup files

getDefaultExcludeList

java.util.ArrayList<java.nio.file.Path> getDefaultExcludeList()

This method can be used to provide a list of files and folders that should be excluded from the export by default.

Returns:

the default exclude files