org.cristalise.kernel.process.resource

Interface ResourceImportHandler

All Known Implementing Classes:

DefaultResourceImportHandler

public interface ResourceImportHandler

Method Summary

Methods

Modifier and Type	Method and Description
CollectionArrayList	getCollections(String name, String ns, String location, Integer version) Returns any collections that this Resource Item should contain.
String	getName()
DomainPath	getPath(String name, String ns) Returns the DomainPath for a specific resource
PropertyDescriptionList	getPropDesc() Should return all of the Properties the resource Item will have on creation.
Set<Outcome>	getResourceOutcomes(String name, String ns, String location, Integer version) Generates the outcomes that the resource should contain.
DomainPath	getTypeRoot() The directory context to search for existing resources.
String	getWorkflowName() Gives the CompActDef name to instantiate to provide the workflow for this type of resource.

Method Detail

getPath

DomainPath getPath(String name,
                 String ns)
                   throws Exception

Returns the DomainPath for a specific resource

Parameters:

ns - - module namespace

name - - resource name

Returns:

Throws:

Exception

getResourceOutcomes

Set<Outcome> getResourceOutcomes(String name,
                               String ns,
                               String location,
                               Integer version)
                                 throws Exception

Generates the outcomes that the resource should contain.

Parameters:

res - - the module resource definition

Returns:

a set of outcomes to be synced with the resource item.

Throws:

Exception - - if the supplied resources are not valid

getWorkflowName

String getWorkflowName()
                       throws Exception

Gives the CompActDef name to instantiate to provide the workflow for this type of resource. Should be found in the CA typeroot (/desc/ActivityDesc/)

Returns:

String workflow name

Throws:

Exception

getPropDesc

PropertyDescriptionList getPropDesc()
                                    throws Exception

Should return all of the Properties the resource Item will have on creation. The Property 'Name' will be created and populated automatically, even if not declared.

Returns:

a PropertyDescriptionList - an arraylist of PropertyDescriptions

Throws:

Exception

getTypeRoot

DomainPath getTypeRoot()

The directory context to search for existing resources. The name of the resource must be unique below this point.

Returns:

Root path

getCollections

CollectionArrayList getCollections(String name,
                                 String ns,
                                 String location,
                                 Integer version)
                                   throws Exception

Returns any collections that this Resource Item should contain.

Returns:

CollectionArrayList

Throws:

Exception

getName

String getName()