#include <group.h>

Public Types
typedef boost::shared_ptr< record >	pointer
typedef std::vector< rcstring >	members_t
Public Member Functions
	~record ()
const source_location &	get_source_location (void) const
rcstring	get_name (void) const
rcstring	get_password (void) const
rcstring	get_gid (void) const
long	get_gid_binary (void) const
const members_t &	get_members (void) const
rcstring	get_use_instead (void) const
bool	is_members_only (void) const
rcstring	representation (void) const
void	append_member (const rcstring &user_name)
bool	is_member (const rcstring &user_name) const
Static Public Member Functions
static pointer	create (const source_location &locn, const rcstring &name, const rcstring &password, const rcstring &gid, const members_t &members)
Private Member Functions
	record (const source_location &locn, const rcstring &name, const rcstring &password, const rcstring &gid, const members_t &members)
Private Attributes
source_location	locn
rcstring	name
rcstring	password
rcstring	gid
members_t	members
rcstring	use_instead
bool	members_only

Detailed Description

The record class is used to represent a group file entry. Values of this type are returned by the get method.

Definition at line 54 of file group.h.

Member Typedef Documentation

typedef std::vector<rcstring> colon_group::record::members_t

Definition at line 64 of file group.h.

typedef boost::shared_ptr<record> colon_group::record::pointer

Definition at line 57 of file group.h.

Constructor & Destructor Documentation

colon_group::record::~record ( )

The destructor.

Definition at line 103 of file group.cc.

colon_group::record::record	(	const source_location &	locn,
		const rcstring &	name,
		const rcstring &	password,
		const rcstring &	gid,
		const members_t &	members
	)		`[private]`

The constructor. It is private on purpose, use the create class method instead.

Parameters:

locn	The source file location of this record.
name	The name of the group.
password	The password of the group.
gid	The group ID of the group.
members	The members (by user name) of the group.

Definition at line 108 of file group.cc.

Member Function Documentation

void colon_group::record::append_member ( const rcstring & user_name )

The append_member method is used to append the given user name to the group's member list.

Definition at line 381 of file group.cc.

colon_group::record::pointer colon_group::record::create	(	const source_location &	locn,
		const rcstring &	name,
		const rcstring &	password,
		const rcstring &	gid,
		const members_t &	members
	)		`[static]`

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

locn	The source file location of this record.
name	The name of the group.
password	The password of the group.
gid	The group ID of the group.
members	The members (by user name) of the group.

Definition at line 153 of file group.cc.

rcstring colon_group::record::get_gid ( void ) const [inline]

Definition at line 88 of file group.h.

long colon_group::record::get_gid_binary ( void ) const

const members_t& colon_group::record::get_members ( void ) const [inline]

Definition at line 90 of file group.h.

rcstring colon_group::record::get_name ( void ) const [inline]

Definition at line 86 of file group.h.

rcstring colon_group::record::get_password ( void ) const [inline]

Definition at line 87 of file group.h.

const source_location& colon_group::record::get_source_location ( void ) const [inline]

Definition at line 85 of file group.h.

rcstring colon_group::record::get_use_instead ( void ) const [inline]

Definition at line 92 of file group.h.

bool colon_group::record::is_member ( const rcstring & user_name ) const

The is_member method is used to test if a particular user name is a member of the group.

Definition at line 347 of file group.cc.

bool colon_group::record::is_members_only ( void ) const [inline]

Definition at line 93 of file group.h.

rcstring colon_group::record::representation ( void ) const

The representation method is used to generate a string which represents the group, suitable for inserting into a group file or group map. (There is no newline on the end.)

Definition at line 355 of file group.cc.