package com.c2kernel.process.resource;

import java.util.Set;

import com.c2kernel.lookup.DomainPath;
import com.c2kernel.persistency.outcome.Outcome;
import com.c2kernel.property.PropertyDescriptionList;

public interface ResourceImportHandler {

	
	/** Returns the DomainPath for a specific resource
	 * @param ns - module namespace
	 * @param name - resource name
	 * @return 
	 */
	public DomainPath getPath(String name, String ns) throws Exception;
	
	/** Generates the outcomes that the resource should contain.
	 * @param res - the module resource definition
	 * @return a set of outcomes to be synced with the resource item.
	 * @throws Exception - if the supplied resources are not valid
	 */
	public Set<Outcome> getResourceOutcomes(String name, String ns, String location, int version) 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/)
	 * @return String workflow name
	 * @throws Exception
	 */
	public String getWorkflowName() 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.
	 * @return a PropertyDescriptionList - an arraylist of PropertyDescriptions
	 * @throws Exception
	 */
	public PropertyDescriptionList getPropDesc() throws Exception;
	
	/** The directory context to search for existing resources. The name of the resource must be unique below this point.
	 * @return Root path
	 */
	public DomainPath getTypeRoot();
	
	public String getName();
	
}