com.edorasware.one.app

Interface AppImportExportManager

All Known Implementing Classes:

DefaultAppImportExportManager

public interface AppImportExportManager

Exposes API to import/export Apps, Process models and App’s Translations.

Method Summary

Modifier and Type	Method and Description
List<Map<String,String>>	appModelDetails(String appGlobalId, String nameLike) Get details of the uploaded app filtered by name.
void	exportApp(String appGlobalId, Collection<String> modelsToExport, javax.servlet.http.HttpServletResponse response) Export App.
void	exportDataModel(String appGlobalId, com.google.common.net.MediaType format, Locale locale, javax.servlet.http.HttpServletResponse response) Export the data model for the given App.
void	exportOverview(String appGlobalId, com.google.common.net.MediaType format, Locale locale, javax.servlet.http.HttpServletResponse response) Export an overview of all attributes defined within the given App.
void	exportTranslation(String appAmbiguousId, com.google.common.net.MediaType format, javax.servlet.http.HttpServletResponse response) Export translations used in form, process and case models of an App.
Object	getAppGraphOverview(String ambiguousId) Get AppGraph overview representation of the App.
void	importApp(String ambiguousId, String actionComment, boolean importAsDuplicate, Collection<String> modelToImportIds) Import an App.
void	importAppTranslation(String appGlobalId, String actionComment) Import App translations.
void	importProcess(String appAmbigousId, boolean validate, String actionComment) Import process(es) from an uploaded BPMN 2.0 XML file.
UploadResponse	uploadImportContent(String appAmbiguousId, org.springframework.web.multipart.MultipartHttpServletRequest request) Upload imported content for an App.

Method Detail

uploadImportContent

UploadResponse uploadImportContent(String appAmbiguousId,
                                   org.springframework.web.multipart.MultipartHttpServletRequest request)
                            throws IOException

Upload imported content for an App.

Parameters:

appAmbiguousId - the ID of the app (either work object ID value or global ID value)

request - Multipart request

Returns:

UploadResponse

Throws:

IOException - if the content could not be uploaded

importApp

void importApp(String ambiguousId,
               String actionComment,
               boolean importAsDuplicate,
               Collection<String> modelToImportIds)
        throws InterruptedException,
               IOException

Import an App.

Parameters:

ambiguousId - the ID of the app (either work object ID value or global ID value)

actionComment - comment to add to the action

importAsDuplicate - flag indicating if the App be imported as duplicate

modelToImportIds - collection of ids which should be imported. In the case of empty collection all models are imported

Throws:

InterruptedException - if the import was interrupted

IOException - if the App file could not be processed

importProcess

void importProcess(String appAmbigousId,
                   boolean validate,
                   String actionComment)
            throws InterruptedException

Import process(es) from an uploaded BPMN 2.0 XML file.

Parameters:

appAmbigousId - the ID of the app (either work object ID value or global ID value)

validate - flag indicating whether the process BPMN xml should be validated before importing.

actionComment - comment to add to the action

Throws:

InterruptedException - if the import was interrupted

importAppTranslation

void importAppTranslation(String appGlobalId,
                          String actionComment)
                   throws InterruptedException

Import App translations.

Parameters:

appGlobalId - global ID of the App.

actionComment - comment to add to the action

Throws:

InterruptedException - if the import was interrupted

exportApp

void exportApp(String appGlobalId,
               Collection<String> modelsToExport,
               javax.servlet.http.HttpServletResponse response)

Export App.

Parameters:

appGlobalId - global ID of the App.

modelsToExport - list of model ids to export in the case when model list is empty all models are exported

response - HttpServletResponse

exportTranslation

void exportTranslation(String appAmbiguousId,
                       com.google.common.net.MediaType format,
                       javax.servlet.http.HttpServletResponse response)

Export translations used in form, process and case models of an App.

Parameters:

appAmbiguousId - the ID of the app (either work object ID value or global ID value)

format - format of the file in which the translations are exported.

response - HttpServletResponse

exportOverview

void exportOverview(String appGlobalId,
                    com.google.common.net.MediaType format,
                    Locale locale,
                    javax.servlet.http.HttpServletResponse response)

Export an overview of all attributes defined within the given App.

Parameters:

appGlobalId - the global ID of the app

format - format of the export file

locale - the locale to be used for translatable content

response - HttpServletResponse

exportDataModel

void exportDataModel(String appGlobalId,
                     com.google.common.net.MediaType format,
                     Locale locale,
                     javax.servlet.http.HttpServletResponse response)

Export the data model for the given App.

Parameters:

appGlobalId - the global ID of the app

format - format of the export file

locale - the locale to be used for translatable content

response - HttpServletResponse

getAppGraphOverview

Object getAppGraphOverview(String ambiguousId)

Get AppGraph overview representation of the App.

Parameters:

ambiguousId - the ID of the app (either work object ID value or global ID value)

Returns:

An AppGraph object.

appModelDetails

List<Map<String,String>> appModelDetails(String appGlobalId,
                                         String nameLike)
                                  throws InterruptedException

Get details of the uploaded app filtered by name.

Parameters:

appGloba1lId - application globalId to identify upload

nameLike - model name substring to search for ignoring case

Returns:

list of WorkObjectDetails matching name like ignore case condition

Throws:

InterruptedException