com.edorasware.one.frontendobject

Interface ModelerDashboardManager

public interface ModelerDashboardManager

Manager interface for Modeler Dashboard REST services.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(String modelId, String comment) Activates a given model.
FrontendObject	createApp(FrontendObject frontendObject, String comment) Creates a new App from the given frontend object.
FrontendObject	createModel(FrontendObject frontendObject, String comment) Creates a new model from the given frontend object.
void	deactivate(String modelId, String comment) Deactivates a given model.
String	deployApp(FrontendObject frontendObject, String comment) Deploys the given App model.
FrontendObject	duplicate(String modelId, String name, String comment) Creates a duplicate of the given model work object template.
String	getAppDataModel(String appModelId) Returns the data model for the given App model.
List<Language>	getAppLanguages(String appModelId) Returns the configured languages for the given App model.
FrontendObject	getModelByKey(String type, String key) Returns the model corresponding to the given key.
String	migrate(String modelId, String comment) Migrates existing work objects to the latest deployed model.
FrontendObject	save(FrontendObject frontendObject, String comment) Saves changes to the given model work object.
FrontendObject	saveApp(FrontendObject frontendObject, String comment) Saves changes to the given App model work object.
FrontendObject	saveMailModel(FrontendObject frontendObject, String comment) Saves changes to the given mail model work object.
void	updateAppDataModel(String appModelId, String modelData) Update App data model on the App model.

Method Detail

createApp

FrontendObject createApp(FrontendObject frontendObject,
                       String comment)
                         throws Exception

Creates a new App from the given frontend object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the App could not be created

createModel

FrontendObject createModel(FrontendObject frontendObject,
                         String comment)
                           throws Exception

Creates a new model from the given frontend object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the model could not be created

getModelByKey

FrontendObject getModelByKey(String type,
                           String key)

Returns the model corresponding to the given key.

Parameters:

type - the expected model type

key - the model key

Returns:

the model frontend object

duplicate

FrontendObject duplicate(String modelId,
                       String name,
                       String comment)
                         throws Exception

Creates a duplicate of the given model work object template.

Parameters:

modelId - the ID of the model work object to be duplicated

name - the name of the new duplicate

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the duplicate could not be created

migrate

String migrate(String modelId,
             String comment)
               throws Exception

Migrates existing work objects to the latest deployed model.

Parameters:

modelId - the model ID

comment - the change comment

Returns:

a summary of the migration

Throws:

Exception - if the work objects could not be migrated

activate

void activate(String modelId,
            String comment)

Activates a given model.

Parameters:

modelId - the ID of the model to be activated

comment - the change comment

deactivate

void deactivate(String modelId,
              String comment)

Deactivates a given model.

Parameters:

modelId - the ID of the model to be deactivated

comment - the change comment

deployApp

String deployApp(FrontendObject frontendObject,
               String comment)
                 throws Exception

Deploys the given App model.

Parameters:

frontendObject - the frontend object for the deployment

comment - the change comment

Returns:

a deployment message

Throws:

Exception - if the App model could not be deployed

save

FrontendObject save(FrontendObject frontendObject,
                  String comment)
                    throws Exception

Saves changes to the given model work object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the changes could not be saved

saveMailModel

FrontendObject saveMailModel(FrontendObject frontendObject,
                           String comment)
                             throws Exception

Saves changes to the given mail model work object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the changes could not be saved

saveApp

FrontendObject saveApp(FrontendObject frontendObject,
                     String comment)
                       throws Exception

Saves changes to the given App model work object.

Parameters:

frontendObject - the frontend object

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the changes could not be saved

getAppDataModel

String getAppDataModel(String appModelId)

Returns the data model for the given App model.

Parameters:

appModelId - the App model ID

Returns:

the data model

updateAppDataModel

void updateAppDataModel(String appModelId,
                      String modelData)

Update App data model on the App model.

Parameters:

appModelId - the App model ID

modelData - the Model Data

getAppLanguages

List<Language> getAppLanguages(String appModelId)

Returns the configured languages for the given App model.

Parameters:

appModelId - the App model ID

Returns:

the configured languages