ICF 3.0.5.47
Technical documentation of ICF Libraries
iauth::CUser Class Reference

#include <CUser.h>

Inheritance diagram for iauth::CUser:
Collaboration diagram for iauth::CUser:

Public Member Functions

 CUser (const QString &userName="", const QString &password="", int userGroup=0)
 
 CUser (const CUser &user)
 
const QString & GetUserName () const
 Get name of user.
 
const QString & GetPassword () const
 Get user's password.
 
bool SetUserName (const QString &name)
 Set name of user.
 
int GetUserGroup () const
 Get group number this user belongs.
 
void SetUserGroup (int group)
 Set group number this user belongs.
 
bool SetPassword (const QString &password)
 Set password of this user.
 
bool CheckPassword (const QString &password) const
 Check, if password is correct.
 
void ResetPassword ()
 Set password to be reset.
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual std::unique_ptr< IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Additional Inherited Members

- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 

Detailed Description

Definition at line 20 of file CUser.h.

Constructor & Destructor Documentation

◆ CUser() [1/2]

iauth::CUser::CUser ( const QString & userName = "",
const QString & password = "",
int userGroup = 0 )

◆ CUser() [2/2]

iauth::CUser::CUser ( const CUser & user)

Member Function Documentation

◆ CheckPassword()

bool iauth::CUser::CheckPassword ( const QString & password) const

Check, if password is correct.

◆ GetPassword()

const QString & iauth::CUser::GetPassword ( ) const

Get user's password.

◆ GetUserGroup()

int iauth::CUser::GetUserGroup ( ) const

Get group number this user belongs.

Returns
number of group, or -1 if this user is disabled.

◆ GetUserName()

const QString & iauth::CUser::GetUserName ( ) const

Get name of user.

◆ ResetPassword()

void iauth::CUser::ResetPassword ( )

Set password to be reset.

◆ Serialize()

virtual bool iauth::CUser::Serialize ( iser::IArchive & archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetPassword()

bool iauth::CUser::SetPassword ( const QString & password)

Set password of this user.

Returns
true, if password was accepted, or false if it is uncompatible with the password guide lines.

◆ SetUserGroup()

void iauth::CUser::SetUserGroup ( int group)

Set group number this user belongs.

Parameters
groupgroup number, or -1 if this user is disabled.

◆ SetUserName()

bool iauth::CUser::SetUserName ( const QString & name)

Set name of user.

Returns
true, if user name was accepted, or false if it is uncompatible with the user name guide lines.

The documentation for this class was generated from the following file:

© Witold Gantzke and Kirill Lepskiy