/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 */
/** BEGIN COPYRIGHT BLOCK
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301  USA 
 * 
 * Copyright (C) 2007 Red Hat, Inc.
 * All rights reserved.
 * END COPYRIGHT BLOCK **/

#ifndef __PS_BUDDY_H__
#define __PS_BUDDY_H__

#ifdef HAVE_CONFIG_H
#ifndef AUTOTOOLS_CONFIG_H
#define AUTOTOOLS_CONFIG_H

/* Eliminate warnings when using Autotools */
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION

#include <config.h>
#endif /* AUTOTOOLS_CONFIG_H */
#endif /* HAVE_CONFIG_H */

/**
 * PSBuddy.h	1.000 05/15/2002
 * 
 * Interface to store buddy online status attributes
 *
 * @author  Surendra Rajam
 * @version 1.000, 05/15/2002
 */
class EXPORT_DECL PSBuddy {
public:
	PSBuddy() { };
	virtual ~PSBuddy() { };
	/**
	 * Gets the buddy name 
	 *
	 * @return name of the buddy
	 */
	virtual const char* GetName() = 0;

	/**
	 * Gets online status of the buddy
	 *
	 * @return true if online, false otherwise
	 */
	virtual bool IsOnline() = 0;

	/**
	 * Gets the value of the specified online status attribute
	 *
	 * @param	attribute type
	 * @param	attribute value upon success
	 * @return 0 on Success, error code otherwise
	 */
	virtual int GetStatus(const char*, char**) = 0;

	/**
	 * Returns a copy of the buddy
	 *
	 * @return A copy of the buddy
	 */
	virtual PSBuddy* Clone() = 0;
};

#endif // __PS_BUDDY_H__