/* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
 * Software engineering by Intevation GmbH
 *
 * This file is Free Software under the GNU AGPL (>=v3) 
 * and comes with ABSOLUTELY NO WARRANTY! Check out the
 * documentation coming with Dive4Elements River for details. 
 */

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;

/**
 * This interface provides artifact specific operation DESCRIBE.
 *
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
@RemoteServiceRelativePath("describe")
public interface DescribeArtifactService extends RemoteService {

    /**
     * This method inserts new data into the an existing artifact.
     *
     * @param url The url of the artifact server.
     * @param locale The locale used for the request.
     * @param artifact The artifact.
     *
     * @return the artifact which description might have been changed.
     */
    public Artifact describe(
        String   locale,
        Artifact artifact)
    throws ServerException;
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :