com.whitestein.lsps.test

Class Module

java.lang.Object

com.whitestein.lsps.test.Module

public class Module
extends Object

Controls uploaded module remotely.

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
long	id The module id.

Constructor Summary

Constructors

Constructor and Description
Module(Module module) Creates the remote for controlling uploaded module.

Method Summary

Modifier and Type	Method and Description
String	getHash() Returns the module hash.
long	getId() Returns the module id.
String	getName() Returns the module name.
String	getVersion() Returns the module version.
ModelInstance	startModelInstance() Starts model instance as user 'admin'.
ModelInstance	startModelInstance(String personId) Starts model instance as a specific user.
void	unload() Unloads this module.
void	unloadWithDependentModules() Unloads this module with it's dependent modules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public final long id

The module id.

Constructor Detail

Module

public Module(Module module)

Creates the remote for controlling uploaded module.

Parameters:

module - the module

Method Detail

getId

public long getId()

Returns the module id.

Returns:

the module id

getName

public String getName()

Returns the module name.

Returns:

the module name

getVersion

public String getVersion()

Returns the module version.

Returns:

the module version

getHash

public String getHash()

Returns the module hash.

Returns:

the module hash

unload

public void unload()

Unloads this module. Fails if the module is already unloaded.

unloadWithDependentModules

public void unloadWithDependentModules()

Unloads this module with it's dependent modules.

startModelInstance

public ModelInstance startModelInstance()

Starts model instance as user 'admin'.

Returns:

started module instance, never null.

startModelInstance

public ModelInstance startModelInstance(String personId)

Starts model instance as a specific user.

Parameters:

personId - the user's identifier

Returns:

started module instance, never null.