Package org.cristalise.kernel.process.module

Class Module

java.lang.Object

org.cristalise.kernel.process.module.ModuleImport

org.cristalise.kernel.entity.imports.ImportItem

org.cristalise.kernel.process.module.Module

All Implemented Interfaces:

DescriptionObject

public class Module
extends ImportItem

Field Summary

Fields inherited from class org.cristalise.kernel.entity.imports.ImportItem

aggregationList, compActDef, dependencyList, initialPath, outcomes, properties, version, wf, workflow, workflowVer

Fields inherited from class org.cristalise.kernel.process.module.ModuleImport

domainPath, isDOMPathExists, isNewItem, itemPath, name, ns, resourceChangeDetails, resourceChangeStatus

Constructor Summary

Constructors

Constructor	Description
Module()

Method Summary

Modifier and Type	Method	Description
void	addImports(Collection<?> contents)	Adds the members of this Collection recursively to the imports of this Module.
void	export(File location)
ArrayList<ModuleConfig>	getConfig()
ArrayList<String>	getDependencies()
String	getDesc()
ModuleImports	getImports()
ModuleInfo	getInfo()
String	getModuleVersion()
Properties	getProperties(boolean isServer)	Returns all Properties
String	getResURL()
ArrayList<ModuleEmbeddedScript>	getScripts()
Integer	getVersion()
boolean	hasDependency(String dep)
void	importAll(ItemProxy serverEntity, AgentProxy systemAgent, boolean reset)	Imports all resources defined in the Module in this order: Resources, Roles, Agents, Items and Module itself
void	runScript(String event, AgentProxy agent, boolean isServer)
void	setConfig(ArrayList<ModuleConfig> config)
void	setImports(Collection<?> contents)	Overwrites the imports with the content of this Collection
void	setImports(ModuleImports theImports)	Add dependency for all children
void	setInfo(ModuleInfo info)
void	setModuleXML(String moduleXML)
void	setName(String name)
void	setNamespace(String ns)
void	setResURL(String resURL)
void	setScripts(ArrayList<ModuleEmbeddedScript> scripts)

Methods inherited from class org.cristalise.kernel.entity.imports.ImportItem

create, createCollections, createCompositeActivity, createItemProperties, exists, getDomainPath, getItemID, getItemPath, getItemPath, getProperties, getProxy, getResourceType, getWfVersion, makeDescCollections, toString

Methods inherited from class org.cristalise.kernel.process.module.ModuleImport

getID, getNamespace, hashCode, setID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.utils.DescriptionObject

export, getName, getNamespace, getXml, getXml, makeDescCollection, setItemPath, setVersion, toOutcome

Constructor Details

Module

public Module()

Method Details

runScript

public void runScript(String event,
 AgentProxy agent,
 boolean isServer)
               throws ScriptingEngineException

Throws:

ScriptingEngineException

setModuleXML

public void setModuleXML(String moduleXML)

setNamespace

public void setNamespace(String ns)

Specified by:

setNamespace in interface DescriptionObject

Overrides:

setNamespace in class ImportItem

setName

public void setName(String name)

Specified by:

setName in interface DescriptionObject

Overrides:

setName in class ImportItem

importAll

public void importAll(ItemProxy serverEntity,
 AgentProxy systemAgent,
 boolean reset)
               throws Exception

Imports all resources defined in the Module in this order: Resources, Roles, Agents, Items and Module itself

Parameters:

serverEntity - not used at the moment but required to implement the import as the workflow of the serverItem

systemAgent - system agent used during the import

reset - whether to reset or not the version of the created/updated resource

Throws:

Exception - All possible exceptions

getProperties

public Properties getProperties(boolean isServer)

Returns all Properties

Parameters:

isServer - is it a server Property or not

Returns:

the Properties

getScripts

public ArrayList<ModuleEmbeddedScript> getScripts()

setResURL

public void setResURL(String resURL)

getDesc

public String getDesc()

getModuleVersion

public String getModuleVersion()

getVersion

public Integer getVersion()

getResURL

public String getResURL()

getDependencies

public ArrayList<String> getDependencies()

hasDependency

public boolean hasDependency(String dep)

getInfo

public ModuleInfo getInfo()

setInfo

public void setInfo(ModuleInfo info)

getImports

public ModuleImports getImports()

setImports

public void setImports(ModuleImports theImports)

Add dependency for all children

Parameters:

theImports - imported resources

setImports

public void setImports(Collection<?> contents)
                throws ObjectNotFoundException,
InvalidDataException

Overwrites the imports with the content of this Collection

Parameters:

contents - the Collection to be used as a list of imports

Throws:

ObjectNotFoundException - the data was not found

InvalidDataException - the data was invalid

addImports

public void addImports(Collection<?> contents)
                throws ObjectNotFoundException,
InvalidDataException

Adds the members of this Collection recursively to the imports of this Module. It checks if the Item referenced by the member has a Collections or not, and adds all of members of those Collection as well.

Parameters:

contents - the Collection to be added as a list of imports

Throws:

ObjectNotFoundException - the data was not found

InvalidDataException - the data was invalid

setConfig

public void setConfig(ArrayList<ModuleConfig> config)

setScripts

public void setScripts(ArrayList<ModuleEmbeddedScript> scripts)

getConfig

public ArrayList<ModuleConfig> getConfig()

export

public void export(File location)