/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

*/

/*!
	\file
	\brief Запрос на обновление сущности в БД.
*/

#if !defined( _OESS_1__DB__SITE__IMPL__ENT_UPDATE_CMD_HPP_ )
#define _OESS_1__DB__SITE__IMPL__ENT_UPDATE_CMD_HPP_

#include <oess_1/db/site/impl/h/request.hpp>
#include <oess_1/db/site/impl/h/response.hpp>

namespace oess_1 {

namespace db {

namespace site {

namespace impl {

//
// ent_update_cmd_t
//

/*!
	\brief Запрос на обновление сущности в БД.

	\attention По соображениям эффективности объекты этого типа нужно
		использовать следующим образом:
		- создать объект-запрос не имея сериализованного образа
		обновляемого объекта;
		- получить методом query_ent_value() доступ к буферу со
		значением объекта;
		- сериализовать объект в полученный буфер.
*/
class	ent_update_cmd_t :
	public request_t
{
	OESS_SERIALIZER( ent_update_cmd_t )
	public :
		ent_update_cmd_t();
		ent_update_cmd_t(
			//! Идентификатор клиента, который выдает этот запрос.
			const std::string & client_id,
			//! Логическое имя БД, в которой объект обновляется.
			const std::string & db_logic_name,
			//! Идентификатор обновляемой сущности.
			const oess_1::ent_id_t & ent_id );
		virtual ~ent_update_cmd_t();

		enum {
			//! Идентификатор запроса.
			e_id = 600
		};

		virtual oess_1::uint_t
		query_req_id() const;

		//! Получить логическое имя БД, в которой объект обновляется.
		const std::string &
		query_db_logic_name() const;

		//! Получить идентификатор обновляющегося объекта.
		const oess_1::ent_id_t &
		query_ent_id() const;

		//! Получить read-write доступ к буферу со значением объекта.
		std::string &
		query_ent_value();

		//! Получить read-only доступ к буферу со значением объекта.		
		const std::string &
		query_ent_value() const;

	private :
		//! Логическое имя БД, в которой объект обновляется.
		std::string	m_db_logic_name;
		//! Буфер со значением объекта.
		std::string	m_ent_value;
		//! Идентификатор обновляемой сущности.
		oess_1::ent_id_t	m_ent_id;
};

//
// ent_update_cmd_result_t
//

/*!
	\brief Ответ на запрос ent_update_cmd.
*/
class	ent_update_cmd_result_t :
	public response_t
{
	OESS_SERIALIZER( ent_update_cmd_result_t )
	public :
		ent_update_cmd_result_t();
		//! Конструктор для случая ошибки.
		ent_update_cmd_result_t(
			const result_t & result );
		virtual ~ent_update_cmd_result_t();

		enum {
			//! Идентификатор ответа.
			e_id = 601
		};

		virtual oess_1::uint_t
		query_resp_id() const;
};

} /* namespace impl */

} /* namespace site */

} /* namespace db */

} /* namespace oess_1 */

#endif
