Package org.cristalise.kernel.entity.imports

Class ImportItem

java.lang.Object

org.cristalise.kernel.process.module.ModuleImport

org.cristalise.kernel.entity.imports.ImportItem

All Implemented Interfaces:

DescriptionObject

Direct Known Subclasses:

Module

public class ImportItem
extends ModuleImport
implements DescriptionObject

Complete Structure for new Item created by different bootstrap uses cases including testing

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<ImportAggregation>	aggregationList
protected CompositeActivityDef	compActDef	Alternative way to provide workflow definition.
protected ArrayList<ImportDependency>	dependencyList
protected String	initialPath
protected ArrayList<ImportOutcome>	outcomes
protected PropertyArrayList	properties
protected Integer	version
protected Workflow	wf	Alternative way to provide workflow.
protected String	workflow
protected Integer	workflowVer

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

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

Constructor Summary

Constructors

Constructor	Description
ImportItem()
ImportItem(String ns, String name, Integer version, String initialPath, ItemPath itemPath, String wf, Integer wfVer)
ImportItem(String ns, String name, String initialPath, ItemPath itemPath, String wf, Integer wfVer)
ImportItem(String name, String initialPath, ItemPath itemPath, String wf)	Constructor with mandatory fields

Method Summary

Modifier and Type	Method	Description
Path	create(AgentPath agentPath, boolean reset, TransactionKey transactionKey)
protected CollectionArrayList	createCollections(TransactionKey transactionKey)
protected CompositeActivity	createCompositeActivity(TransactionKey transactionKey)	This method enables to use ImportItem in different bootstrap uses cases (e.g.
protected PropertyArrayList	createItemProperties()
boolean	exists(TransactionKey transactionKey)
DomainPath	getDomainPath()
String	getItemID()
ItemPath	getItemPath()
ItemPath	getItemPath(TransactionKey transactionKey)	Returns ItemPath if it was already set.
ArrayList<Property>	getProperties()	Method required to be backward compatible with castor marshalling.
ItemProxy	getProxy()
BuiltInResources	getResourceType()
int	getWfVersion()	Get the workflow version.
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setName(String name)
void	setNamespace(String ns)
String	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, getVersion, getXml, getXml, makeDescCollection, setItemPath, setVersion, toOutcome

Field Details

version

protected Integer version

initialPath

protected String initialPath

workflow

protected String workflow

workflowVer

protected Integer workflowVer

properties

protected PropertyArrayList properties

aggregationList

protected ArrayList<ImportAggregation> aggregationList

dependencyList

protected ArrayList<ImportDependency> dependencyList

outcomes

protected ArrayList<ImportOutcome> outcomes

compActDef

protected CompositeActivityDef compActDef

Alternative way to provide workflow definition. It is not marshallable by castor, therefore cannot be set in module.xml

wf

protected Workflow wf

Alternative way to provide workflow. It is not marshalable by castor, therefore cannot be set in module.xml

Constructor Details

ImportItem

public ImportItem()

ImportItem

public ImportItem(String ns,
 String name,
 Integer version,
 String initialPath,
 ItemPath itemPath,
 String wf,
 Integer wfVer)

ImportItem

public ImportItem(String ns,
 String name,
 String initialPath,
 ItemPath itemPath,
 String wf,
 Integer wfVer)

ImportItem

public ImportItem(String name,
 String initialPath,
 ItemPath itemPath,
 String wf)

Constructor with mandatory fields

Parameters:

name -

initialPath -

itemPath -

wf -

Method Details

getDomainPath

public DomainPath getDomainPath()

exists

public boolean exists(TransactionKey transactionKey)

Specified by:

exists in interface DescriptionObject

getItemPath

public ItemPath getItemPath()

Specified by:

getItemPath in interface DescriptionObject

getProxy

public ItemProxy getProxy()

getWfVersion

public int getWfVersion()

Get the workflow version. Default workflow version is 0 if not given

Returns:

workflow version (default 0)

getItemPath

public ItemPath getItemPath(TransactionKey transactionKey)

Returns ItemPath if it was already set. If it was not set yet, it checks DomianPath.target as well.

Overrides:

getItemPath in class ModuleImport

setNamespace

public void setNamespace(String ns)

Specified by:

setNamespace in interface DescriptionObject

Overrides:

setNamespace in class ModuleImport

setName

public void setName(String name)

Specified by:

setName in interface DescriptionObject

create

public Path create(AgentPath agentPath,
 boolean reset,
 TransactionKey transactionKey)
            throws InvalidDataException,
ObjectCannotBeUpdated,
ObjectNotFoundException,
CannotManageException,
ObjectAlreadyExistsException,
InvalidCollectionModification,
PersistencyException

Specified by:

create in class ModuleImport

Throws:

InvalidDataException

ObjectCannotBeUpdated

ObjectNotFoundException

CannotManageException

ObjectAlreadyExistsException

InvalidCollectionModification

PersistencyException

createItemProperties

protected PropertyArrayList createItemProperties()

Returns:

createCompositeActivity

protected CompositeActivity createCompositeActivity(TransactionKey transactionKey)
                                             throws ObjectNotFoundException,
InvalidDataException

This method enables to use ImportItem in different bootstrap uses cases (e.g. testing)

Returns:

the the domain workflow of the Item

Throws:

ObjectNotFoundException

InvalidDataException

createCollections

protected CollectionArrayList createCollections(TransactionKey transactionKey)
                                         throws InvalidCollectionModification,
ObjectNotFoundException,
ObjectAlreadyExistsException

Parameters:

transactionKey -

Returns:

Throws:

InvalidCollectionModification

ObjectNotFoundException

ObjectAlreadyExistsException

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

makeDescCollections

public CollectionArrayList makeDescCollections(TransactionKey transactionKey)
                                        throws InvalidDataException,
ObjectNotFoundException

Specified by:

makeDescCollections in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

getResourceType

public BuiltInResources getResourceType()

Specified by:

getResourceType in interface DescriptionObject

toString

public String toString()

Overrides:

toString in class Object

getProperties

public ArrayList<Property> getProperties()

Method required to be backward compatible with castor marshalling. check issue #518

Returns: