/*

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_LOAD_CMD_HPP_ )
#define _OESS_1__DB__SITE__IMPL__ENT_LOAD_CMD_HPP_

#include <oess_1/defs/h/ent_id.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 {

//FIX ME: вполне возможно, что в запросе ent_load нужно
//сообщать имя типа сущности в клиентском приложении. Тогда
//на стороне сервера можно будет проверять возможность
//загрузки сущности.
//Это может быть важно при блокировке сущностей во время
//транзакции.

//
// ent_load_cmd_t
//

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

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

		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;

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

//
// ent_load_cmd_result_t
//

/*!
	\brief Ответ на запрос ent_load_cmd.

	\attention По соображениям эффективности объекты этого типа нужно
		использовать следующим образом:
		- создать объект-ответ не имея сериализованного образа
		обновляемого объекта;
		- получить методом query_ent_value() доступ к буферу со
		значением объекта;
		- поместить сериализованное представление объекта
		в полученный буфер.
*/
class	ent_load_cmd_result_t :
	public response_t
{
	OESS_SERIALIZER( ent_load_cmd_result_t )
	public :
		ent_load_cmd_result_t();
		//! Конструктор для случая ошибки.
		ent_load_cmd_result_t(
			//! Описание ошибки.
			const result_t & result );
		virtual ~ent_load_cmd_result_t();

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

		virtual oess_1::uint_t
		query_resp_id() const;

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

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

	private :
		//! Значение сущности.
		std::string	m_ent_value;
};

} /* namespace impl */

} /* namespace site */

} /* namespace db */

} /* namespace oess_1 */

#endif
