com.bq.oss.lib.mongo.repository.PartialUpdateRepository Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014 StarTIC
 */
package com.bq.oss.lib.mongo.repository;

import java.io.Serializable;

import org.springframework.data.mongodb.repository.MongoRepository;

/**
 * This repository interface adds functionality for partial updates.
 * 
 * @author Alexander De Leon
 * 
 */
public interface PartialUpdateRepository extends MongoRepository {

	/**
	 * Partially updates (if exists) the object with the specified id, using all non-null values in the data parameter.
	 * Optionally a list of fieldsToDelete can be specified to unset those fields in the DB.
	 * 
	 * @param id
	 *            The identifier of the object to update
	 * @param data
	 *            An object containing the values that most be updated
	 * @param fieldsToDelete
	 *            An optional list of fields to unset
	 * @return true if such object is found and updated
	 */
	public boolean patch(ID id, E data, String... fieldsToDelete);

	/**
	 * Partially updates (if exists) the object identified by the the identifier field expected in the data object. The
	 * object will be updated using all non-null values in the data parameter. Optionally a list of fieldsToDelete can
	 * be specified to unset those fields in the DB.
	 *
	 * @param data
	 *            An object containing the values that most be updated
	 * @param fieldsToDelete
	 *            An optional list of fields to unset
	 * @return true if such object is found and updated
	 */
	public boolean patch(E data, String... fieldsToDelete);
}