source: VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/de/uni_leipzig/asv/clarin/webservices/pidservices2/interfaces/PidWriter.java @ 5497

package de.uni_leipzig.asv.clarin.webservices.pidservices2.interfaces;

import java.util.Map;

import org.apache.commons.httpclient.HttpException;

import de.uni_leipzig.asv.clarin.webservices.pidservices2.Configuration;
import de.uni_leipzig.asv.clarin.webservices.pidservices2.HandleField;

/**
 * Registers new handles at handle server or modifies existing handles
 * 
 * @author Thomas Eckart
 * 
 */
public interface PidWriter {
    
        /**
         * Try to register a new PID at handle server. Returns registered handle if successful.
         * 
         * @param configuration
         * @param fieldMap
         *            handle mapping field -> value
         * @param pid PID to register
         * @return registered handle identifier
         * @throws HTTPException if the handle could not be created, possibly
         * because the ID already exists at the server
         */
        public String registerNewPID(final Configuration configuration, Map<HandleField, String> fieldMap, String pid)
            throws HttpException;
        /**
         * Try to register a new PID at handle server. Returns registered handle if successful.
         * 
         * @param configuration
         * @param fieldMap
         *            handle mapping field -> value
         * @return registered handle identifier
         * @throws HTTPException
         */
        public String registerNewPID(final Configuration configuration, Map<HandleField, String> fieldMap)
                        throws HttpException;

        /**
         * Modify existing PID. This method overwrites all existing fields! Fields that should remain stored for the PID have to be added to fieldMap.
         * 
         * @param configuration
         * @param pid
         *            Persistent identifier that will be modified/overwritten
         * @param fieldMap
         *            new field values: mapping handle field -> value
         */
        public void modifyPid(final Configuration configuration, final String pid, Map<HandleField, String> fieldMap);
}