com.whitestein.lsps.engine

Interface ModelManagementService

All Known Subinterfaces:

ModelManagementServiceLocal, ModelManagementServiceRemote

All Known Implementing Classes:

ModelManagementServiceBean

public interface ModelManagementService

Interface for manipulating with models/modules repository

Method Summary

Modifier and Type	Method and Description
ByteData	exportModules(long moduleId) Create archive(ZIP) file of modules identified by the given module id.
ModuleEntryList	findModuleEntriesByType(long moduleId, String type) Returns a list of module entries for the given module and type.
ModuleEntry	findModuleEntryByPath(long moduleId, String path) Returns content of the specified process resource for given module.
ModuleList	findModules(ModuleCriteria criteria) Returns collection of all modules in the repository according to given criteria
ModuleDetailsList	findModulesDetails(ModuleCriteria criteria) Returns collection of details of all modules in the repository according to given criteria
List<Module>	getDependentModules(List<Long> moduleIds) Returns list of modules that imports one of given modules.
long	getExecutableModulesCount()
Module	getLatestModule(String name) Returns the latest module with a given name.
Module	getModule(long moduleId) Finds module according to module id
ModuleEntry	getModuleEntry(long entryId) Returns resource data for given id from repository.
boolean	isConfirmModelUpload() Gets the server hint indicating whether the model upload should be explicitly confirmed by the user.
void	unloadModule(long moduleId) Removes the module from the system.
void	unloadModules(List<Module> modules) Unloads modules.
void	unloadModuleWithDependentModules(long moduleId) Removes the module from the system.
ModulesUploadResult	uploadModules(ByteData data, StringProperties uploadProperties) Process archive represented by byte array.

Method Detail

uploadModules

ModulesUploadResult uploadModules(ByteData data,
                                  StringProperties uploadProperties)
                           throws ModelUploadException

Process archive represented by byte array. Archive is represented as ZIP archive containing modules.

Parameters:

data - byte array representation of archive

uploadProperties - the upload properties

Returns:

list of uploaded modules

Throws:

ModelUploadException

exportModules

ByteData exportModules(long moduleId)
                throws ModuleNotFoundException

Create archive(ZIP) file of modules identified by the given module id.

Parameters:

moduleId -

Returns:

byte array of created archive

Throws:

ModuleNotFoundException

findModules

ModuleList findModules(ModuleCriteria criteria)

Returns collection of all modules in the repository according to given criteria

Parameters:

criteria -

Returns:

collection of Modules

findModulesDetails

ModuleDetailsList findModulesDetails(ModuleCriteria criteria)

Returns collection of details of all modules in the repository according to given criteria

Parameters:

criteria -

Returns:

collection of ModuleDetails

getExecutableModulesCount

long getExecutableModulesCount()

Returns:

a number of executable modules

getModule

Module getModule(long moduleId)

Finds module according to module id

Parameters:

moduleId - id of model

Returns:

found Module or null if not found

findModuleEntriesByType

ModuleEntryList findModuleEntriesByType(long moduleId,
                                        String type)
                                 throws ModuleNotFoundException

Returns a list of module entries for the given module and type.

Parameters:

moduleId - id of module

type - type of the file

Returns:

a list of module entries for the given module and type

Throws:

ModuleNotFoundException

findModuleEntryByPath

ModuleEntry findModuleEntryByPath(long moduleId,
                                  String path)
                           throws ModuleNotFoundException

Returns content of the specified process resource for given module.

Parameters:

moduleId - the module id

path - path to binary content

Returns:

BinaryHandle

Throws:

ModuleNotFoundException

getModuleEntry

ModuleEntry getModuleEntry(long entryId)

Returns resource data for given id from repository.

Parameters:

entryId -

Returns:

module entry

unloadModule

void unloadModule(long moduleId)
           throws ModuleNotFoundException,
                  ModelUnloadException

Removes the module from the system. The module must not be referenced by any other modules. If there are any running model instances, they are terminated.

Parameters:

moduleId -

Throws:

ModuleNotFoundException - if the module does not exist

ModelUnloadException

unloadModuleWithDependentModules

void unloadModuleWithDependentModules(long moduleId)
                               throws ModuleNotFoundException,
                                      ModelUnloadException

Removes the module from the system. If there are any other modules which reference it, they will be unloaded too. If there are any running model instances, they are terminated.

Parameters:

moduleId -

Throws:

ModuleNotFoundException - if the module does not exist

ModelUnloadException

unloadModules

void unloadModules(List<Module> modules)
            throws ModuleNotFoundException,
                   ModelUnloadException

Unloads modules.

Parameters:

modules -

Throws:

ModuleNotFoundException

ModelUnloadException

getDependentModules

List<Module> getDependentModules(List<Long> moduleIds)

Returns list of modules that imports one of given modules.

Parameters:

moduleIds - id of modules

Returns:

list of modules that imports one of given modules

isConfirmModelUpload

boolean isConfirmModelUpload()

Gets the server hint indicating whether the model upload should be explicitly confirmed by the user.

Returns:

server hint to confirm model upload explicitly by the user

getLatestModule

Module getLatestModule(String name)

Returns the latest module with a given name. Unloaded modules are ignored. Imports and entries are not included in the result.

Parameters:

name -

Returns:

the latest module or null