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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<ModelInstance>	findModelInstances() Finds all model instances of this module.
List<ModelInstance>	findModelInstances(ModelInstanceState state, ModelInstanceState... rest) Finds all model instances of this module with specified states.
String	getHash() Returns the module hash.
long	getId() Returns the module id.
String	getName() Returns the module name.
LspsRemote	getRemote() Returns the associated remote.
String	getVersion() Returns the module version.
int	hashCode()
ModelInstance	startModelInstance() Starts model instance as a user connected via associated remote.
ModelInstance	startModelInstance(Map<String,String> properties) Starts a model instance using given properties.
ModelInstance	startModelInstance(String personId) Starts a model instance as a specific user.
String	toString()
void	unload() Unloads this module.
void	unloadWithDependentModules() Unloads this module with it's dependent modules.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRemote

public LspsRemote getRemote()

Returns the associated remote.

Returns:

the associated remote

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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 a user connected via associated remote.

Returns:

started module instance, never null.

startModelInstance

public ModelInstance startModelInstance(String personId)

Starts a model instance as a specific user.

Parameters:

personId - the model instance initiator (the user's identifier)

Returns:

started module instance, never null.

startModelInstance

public ModelInstance startModelInstance(Map<String,String> properties)

Starts a model instance using given properties.

Parameters:

properties -

Returns:

the started model instance, never null

findModelInstances

public List<ModelInstance> findModelInstances()

Finds all model instances of this module.

Returns:

a list of model instances

findModelInstances

public List<ModelInstance> findModelInstances(ModelInstanceState state,
                                              ModelInstanceState... rest)

Finds all model instances of this module with specified states.

Parameters:

state -

rest -

Returns:

a list of model instances