package org.dive4elements.river.client.client.services;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

import org.dive4elements.river.client.shared.exceptions.ServerException;
import org.dive4elements.river.client.shared.model.Artifact;
import org.dive4elements.river.client.shared.model.Collection;


/**
 * This interface describes the service to add an existing artifact to an
 * existing collection.
 *
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
@RemoteServiceRelativePath("add-artifact")
public interface AddArtifactService extends RemoteService {

    /**
     * Adds an artifact to a collection.
     *
     * @param collection The Collection that should be extended.
     * @param artifact   The artifact that should be added.
     * @param url        The url of the artifact server.
     *
     * @return the Collection after the operation.
     */
    Collection add(
        Collection collection,
        Artifact   artifact,
        String     locale)
    throws ServerException;
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :