UpdateEntity.java

package org.sigmah.shared.command;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */

import java.util.Map;

import org.sigmah.client.util.ToStringBuilder;
import org.sigmah.shared.command.base.AbstractCommand;
import org.sigmah.shared.command.result.VoidResult;
import org.sigmah.shared.dto.base.EntityDTO;

import com.extjs.gxt.ui.client.data.RpcMap;

/**
 * <p>
 * Updates a domain entity on the server.
 * </p>
 *
 * Some entities require specialized commands to create or update. See:
 * <ul>
 * <li>{@link org.sigmah.shared.command.AddPartner}</li>
 * <li>{@link org.sigmah.shared.command.UpdateUserPermissions}</li>
 * <li>{@link org.sigmah.shared.command.UpdateSubscription}</li>
 * </ul>
 *
 * @author Alex Bertram (akbertram@gmail.com)
 * @author Denis Colliot (dcolliot@ideia.fr)
 */
public class UpdateEntity extends AbstractCommand<VoidResult> {

	private Integer id;
	private String entityName;
	private RpcMap changes;

	protected UpdateEntity() {
		// Serialization.
	}

	public UpdateEntity(final EntityDTO<?> model, final Map<String, Object> changes) {
		this(model.getEntityName(), (Integer)model.getId(), changes);
	}

	public UpdateEntity(final String entityName, final Integer id, final Map<String, Object> changes) {
		this.entityName = entityName;
		this.id = id;
		this.changes = new RpcMap();
		this.changes.putAll(changes);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void appendToString(final ToStringBuilder builder) {
		builder.append("id", id);
		builder.append("entityName", entityName);
		builder.append("changes", changes);
	}

	public Integer getId() {
		return id;
	}

	public String getEntityName() {
		return entityName;
	}

	public RpcMap getChanges() {
		return changes;
	}

}