/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
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();
	
}