0.6.0-1 release
[manu/suphp.git] / src / GroupInfo.hpp
1 /*
2     suPHP - (c)2002-2005 Sebastian Marsching <sebastian@marsching.com>
3
4     This file is part of suPHP.
5
6     suPHP is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     suPHP is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with suPHP; if not, write to the Free Software
18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21 #ifndef SUPHP_GROUPINFO_H
22
23 namespace suPHP {
24     class GroupInfo;
25 };
26
27 #define SUPHP_GROUPINFO_H
28
29 #include <string>
30 #include <vector>
31
32 #include "LookupException.hpp"
33
34 namespace suPHP {
35     /**
36      * Class encapsulating group information.
37      */
38     class GroupInfo {
39     private:
40         int gid;
41
42     public:
43         /**
44          * Constructor without arguments.
45          * Does not create a "valid" object, since it has no well defined GID
46          */
47         GroupInfo();
48
49         /**
50          * Contructor (creates group object from GID)
51          */
52         GroupInfo(int gid);
53
54         /**
55          * Returns groupname
56          */
57         std::string getGroupname() const throw (LookupException);
58         
59         /**
60          * Returns GID
61          */
62         int getGid() const;
63
64         /**
65          * Compares to GroupInfo objects for equality
66          */
67         bool operator==(const GroupInfo& ginfo) const;
68         
69         /**
70          * Overloaded operator !=
71          */
72         bool operator!=(const GroupInfo& ginfo) const; 
73     };
74 };
75
76 #endif // SUPHP_GROUPINFO_H