michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #pragma once
michael@0: 
michael@0: #include <string>
michael@0: 
michael@0: #include "CC_Common.h"
michael@0: #include "ECC_Types.h"
michael@0: 
michael@0: namespace CSF
michael@0: {
michael@0: 	DECLARE_NS_PTR_VECTOR(PhoneDetails);
michael@0: 	class ECC_API PhoneDetails
michael@0: 	{
michael@0: 	public:
michael@0:                 NS_INLINE_DECL_THREADSAFE_REFCOUNTING(PhoneDetails)
michael@0: 		virtual ~PhoneDetails() {}
michael@0: 		/**
michael@0: 		 * Get the device name (the CUCM device name) and the free text description.
michael@0: 		 */
michael@0: 		virtual std::string getName() const = 0;
michael@0: 		virtual std::string getDescription() const = 0;
michael@0: 
michael@0: 		/**
michael@0: 		 * Get the model number (the internal CUCM number, not the number printed on the phone)
michael@0: 		 * and the corresponding description (which normally does include the number printed on the phone).
michael@0: 		 * Returns -1, "" if unknown
michael@0: 		 */
michael@0: 		virtual int getModel() const = 0;
michael@0: 		virtual std::string getModelDescription() const = 0;
michael@0: 
michael@0: 		virtual bool isSoftPhone() = 0;
michael@0: 
michael@0: 		/**
michael@0: 		 * List the known directory numbers of lines associated with the device.
michael@0: 		 * Empty list if unknown.
michael@0: 		 */
michael@0: 		virtual std::vector<std::string> getLineDNs() const = 0;
michael@0: 
michael@0: 		/**
michael@0: 		 * Current status of the device, if known.
michael@0: 		 */
michael@0: 		virtual ServiceStateType::ServiceState getServiceState() const = 0;
michael@0: 
michael@0: 		/**
michael@0: 		 * TFTP config of device, and freshness of the config.
michael@0: 		 */
michael@0: 		virtual std::string getConfig() const = 0;
michael@0: 
michael@0: 	protected:
michael@0: 		PhoneDetails() {}
michael@0: 
michael@0: 	private:
michael@0: 		PhoneDetails(const PhoneDetails&);
michael@0: 		PhoneDetails& operator=(const PhoneDetails&);
michael@0: 	};
michael@0: };