ImagingTools Core SDK
Public Types | Public Member Functions | List of all members
imtauth::IAccountInfoabstract

#include <IAccountInfo.h>

Inherits iser::IObject.

Inherited by imtauth::CAccountInfo [virtual].

Public Types

enum  AccountType { AT_PERSON , AT_COMPANY , AT_REPRESENTATIVE }
 
enum  MetaInfoTypes {
  MIT_ACCOUNT_TYPE = idoc::IDocumentMetaInfo::MIT_USER + 1 , MIT_ACCOUNT_NAME , MIT_ACCOUNT_DESCRIPTION , MIT_CONTACT_EMAIL ,
  MIT_CONTACT_BIRTHDAY , MIT_CONTACT_FIRST_NAME , MIT_CONTACT_LAST_NAME , MIT_CONTACT_NICKNAME
}
 

Public Member Functions

virtual AccountType GetAccountType () const =0
 
virtual void SetAccountType (AccountType accountType)=0
 
virtual QString GetAccountName () const =0
 
virtual void SetAccountName (QString accountName)=0
 
virtual QString GetAccountDescription () const =0
 
virtual void SetAccountDescription (QString accountDescription)=0
 
virtual const iimg::IBitmap & GetAccountPicture () const =0
 
virtual void SetAccountPicture (const iimg::IBitmap &picture)=0
 
virtual const IContactInfoGetAccountOwner () const =0
 
virtual void SetAccountOwner (const IContactInfo &ownerInfo)=0
 
virtual const iauth::IRightsProvider & GetAccountRights () const =0
 

Detailed Description

Interface for describing an user account.

Definition at line 23 of file IAccountInfo.h.

Member Enumeration Documentation

◆ AccountType

Supported account types.

Enumerator
AT_PERSON 

A personal account.

AT_COMPANY 

A company account.

AT_REPRESENTATIVE 

An account of a company representative.

Definition at line 29 of file IAccountInfo.h.

◆ MetaInfoTypes

Enumerator
MIT_ACCOUNT_TYPE 

Account type given as AccountType.

MIT_ACCOUNT_NAME 

Account name given as QString.

MIT_ACCOUNT_DESCRIPTION 

Account description given as QString.

MIT_CONTACT_EMAIL 

Contact email given as QString.

MIT_CONTACT_BIRTHDAY 

Contact birthday given as QDate.

MIT_CONTACT_FIRST_NAME 

Contact first name given as QString.

MIT_CONTACT_LAST_NAME 

Contact last name given as QString.

MIT_CONTACT_NICKNAME 

Contact nickname given as QString.

Definition at line 48 of file IAccountInfo.h.

Member Function Documentation

◆ GetAccountDescription()

virtual QString imtauth::IAccountInfo::GetAccountDescription ( ) const
pure virtual

Get description of the account.

◆ GetAccountName()

virtual QString imtauth::IAccountInfo::GetAccountName ( ) const
pure virtual

Get name of the account.

◆ GetAccountOwner()

virtual const IContactInfo * imtauth::IAccountInfo::GetAccountOwner ( ) const
pure virtual

Get information about the person who owns and manages this account.

◆ GetAccountPicture()

virtual const iimg::IBitmap & imtauth::IAccountInfo::GetAccountPicture ( ) const
pure virtual

Get account picture.

◆ GetAccountRights()

virtual const iauth::IRightsProvider & imtauth::IAccountInfo::GetAccountRights ( ) const
pure virtual

Get the access to the rights provider associated with this account.

◆ GetAccountType()

virtual AccountType imtauth::IAccountInfo::GetAccountType ( ) const
pure virtual

Get information about the type of the account.

See also
AccountType

◆ SetAccountDescription()

virtual void imtauth::IAccountInfo::SetAccountDescription ( QString  accountDescription)
pure virtual

Set description of the account.

◆ SetAccountName()

virtual void imtauth::IAccountInfo::SetAccountName ( QString  accountName)
pure virtual

Set name of the account.

◆ SetAccountOwner()

virtual void imtauth::IAccountInfo::SetAccountOwner ( const IContactInfo ownerInfo)
pure virtual

Set informations about account owner.

◆ SetAccountPicture()

virtual void imtauth::IAccountInfo::SetAccountPicture ( const iimg::IBitmap &  picture)
pure virtual

Set account picture.

◆ SetAccountType()

virtual void imtauth::IAccountInfo::SetAccountType ( AccountType  accountType)
pure virtual

Set information about the type of the account.

See also
AccountType