/*-
 * Copyright (c) 2005 - 2011 CAS Dev Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 4. Neither the name of the CAS Dev. Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 *      ASObject.hpp
 *
 * $CAS$
 */
#ifndef _AS_OBJECT_HPP__
#define _AS_OBJECT_HPP__ 1

/**
  @file ASObject.hpp
  @brief Application server object
*/
#include "ASEventCodes.hpp"
#include "ASTypes.hpp"

namespace CAS // C++ Application Server
{

/**
  @class ASObject ASObject.hpp <ASObject.hpp>
  @brief Application server object
*/
class ASObject
{
public:
	/**
	  @brief Get object type
	  @return human-readable type of object
	*/
	virtual CCHAR_P GetObjectType() const = 0;

	/**
	  @brief Get object name
	  @return human-readable name of object
	*/
	virtual CCHAR_P GetObjectName() const = 0;

	/**
	  @brief Handle event
	  @param iEventId - event ID
	  @return HANDLER_OK - if success, HANDLER_ERROR - if any error occured, HANDLER_DONE - if no futher processing need

	  Each object located in pool can subscribe to any event.
	  This method is callback for notification mechanism.
	*/
	virtual INT_32 HandleEvent(const UINT_32 iEventId);

	/**
	  @brief A virtual destructor
	*/
	virtual ~ASObject() throw();
};

} // namespace CAS
#endif // _AS_OBJECT_HPP__
// End.
