git.maemo.org Git - qtmeetings/blob - src/Domain/Room.h

   1 #ifndef ROOM_H_
   2 #define ROOM_H_
   3
   4 #include <QString>
   5
   6 //! Domain class. Describe a meeting room resource on Microsoft Exchange Server 2007.
   7 /*!
   8  * Domain class. Describe a meeting room resource on Microsoft Exchange Server 2007.
   9  */
  10 class Room
  11 {
  12 public:
  13         //! Enumeration of the status of the room.
  14         /*!
  15          * Enumeration of the status of the room. The room instance can have one of the two states.
  16          */
  17         enum Status
  18         {
  19                 BusyStatus, /*!< The room is reserved. */
  20                 FreeStatus  /*!< The room is free. */
  21         };
  22
  23 public:
  24         //! Constructor.
  25         /*!
  26          * Constructor to initialize a Room instance.
  27          * \param aName The name of the meeting room.
  28          * \param aAddress The mail address of the meeting room.
  29          */
  30         Room( const QString &aName, const QString &aAddress );
  31         //! Destructor.
  32         virtual ~Room();
  33
  34         //! Gets the name of the room.
  35         /*!
  36          * Gets the name of the room.
  37          * \return The string containing the name.
  38          */
  39         QString name() const;
  40         //! Gets the address of the room.
  41         /*!
  42          * Gets the address of the room.
  43          * \return The string containing the address.
  44          */
  45         QString address() const;
  46         //! Checks if two objects are equal.
  47         /*!
  48          * Checks if the another same type object is equal to the current instance.
  49          * \param *aOther The pointer to another Room class instance.
  50          * \return TRUE if equals; otherwise, FALSE.
  51          */
  52         bool equals( const Room &aOther ) const;
  53         //! Makes a string to identify a room.
  54         /*!
  55          * Makes one string of the name and the address of the room.
  56          * \return The string containing the name and address of the room.
  57          */
  58         QString toString() const;
  59         //! Method to compare equalness of two rooms.
  60         /*!
  61          * Compares if two rooms are equal. Is not case sensitive.
  62          * \param *aRoom1 A Pointer to the first room class instance.
  63          * \param *aRoom2 A Pointer to the second room class instance.
  64          * \return The string containing the name and address of the room.
  65          */
  66         static bool caseInsensitiveLessThan( const Room *aRoom1, const Room *aRoom2 );
  67
  68 private:
  69         //! The name for the room in this instance.
  70         QString iName;
  71         //! The address for the room in this instance.
  72         QString iAddress;
  73
  74 };
  75
  76 #endif /*ROOM_H_*/