Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::UPN::UpnDbCustomerRecord Class Reference

An object that represents a customer. More...

+ Inheritance diagram for SoftwareAndServices::Library::UPN::UpnDbCustomerRecord:
+ Collaboration diagram for SoftwareAndServices::Library::UPN::UpnDbCustomerRecord:

Public Member Functions

 UpnDbCustomerRecord (UpnDbUpnId_t CompanyId)
 UpnDbCustomerRecord() - Constructor. More...
 
virtual ~UpnDbCustomerRecord ()
 ~UpnDbCustomerRecord() - Destructor. More...
 
bool Add (UpnDbAuthHandle_t Auth)
 Add a new UpnDbCustomer. More...
 
void CompanyId (UpnDbUpnId_t TheId)
 Set the company ID to use. More...
 
bool GetActive () const
 true when this record is active. More...
 
time_t GetCreated () const
 
UpnDbUpnId_t GetCreatedByUpnId () const
 
bool GetHasChanged () const
 
UpnDbUpnId_t Id () const
 Get the ID (UPN ID) of the employee. More...
 
void Id (UpnDbUpnId_t TheId)
 Set the ID of the employee. More...
 
uint64_t LoadAll (UpnDbAuthHandle_t Auth)
 Load all customer records into cache. More...
 
bool Remove (UpnDbAuthHandle_t Auth)
 Remove an existig UpnDbCustomer. More...
 
void SetActive (bool IsActive)
 Indicate if this record is active. More...
 
bool SetCreated (String &TimeOut)
 
void SetCreatedByUpnId (UpnDbUpnId_t Creator)
 Set the created by UPN ID. More...
 
bool Update (UpnDbAuthHandle_t Auth) const
 Update an existig UpnDbCustomer. More...
 

Static Public Member Functions

static UpnDbUpnId_t CompanyId ()
 Get the company ID being used. More...
 
static UpnDbUpnId_t GetSiteId ()
 
static void SetSiteId (UpnDbAuthHandle_t Auth, UpnDbUpnId_t SiteUpnId)
 Set the applications SITE ID. More...
 

Protected Member Functions

void SetCreated (time_t When)
 Set the created time. More...
 
void SetHasChanged (bool ItChanged)
 Set change state. More...
 

Detailed Description

An object that represents a customer.

Definition at line 69 of file UpnDbCustomerRecord.hpp.

Constructor & Destructor Documentation

◆ UpnDbCustomerRecord()

SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::UpnDbCustomerRecord ( UpnDbUpnId_t  CompanyId)

UpnDbCustomerRecord() - Constructor.

Parameters
CompanyIdThe UPN ID of the company.

◆ ~UpnDbCustomerRecord()

virtual SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::~UpnDbCustomerRecord ( )
virtual

~UpnDbCustomerRecord() - Destructor.

Member Function Documentation

◆ Add()

bool SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::Add ( UpnDbAuthHandle_t  Auth)
virtual

Add a new UpnDbCustomer.

Parameters
AuthAn authentiation handle.
CompanyIdThe UPN ID of the company.
Returns
true if saved.

Implements SoftwareAndServices::Library::UPN::UpnDbRecord.

◆ CompanyId() [1/2]

static UpnDbUpnId_t SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::CompanyId ( )
static

Get the company ID being used.

◆ CompanyId() [2/2]

void SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::CompanyId ( UpnDbUpnId_t  TheId)

Set the company ID to use.

◆ GetActive()

bool SoftwareAndServices::Library::UPN::Change::GetActive ( ) const
inherited

true when this record is active.

◆ GetCreated()

time_t SoftwareAndServices::Library::UPN::Change::GetCreated ( ) const
inherited
Returns
The time created, as a time_t.

◆ GetCreatedByUpnId()

UpnDbUpnId_t SoftwareAndServices::Library::UPN::Change::GetCreatedByUpnId ( ) const
inherited
Returns
the UPN ID of the creator of the record.

◆ GetHasChanged()

bool SoftwareAndServices::Library::UPN::Change::GetHasChanged ( ) const
inherited
Returns
true when this record has been updated and needs changed.

◆ GetSiteId()

static UpnDbUpnId_t SoftwareAndServices::Library::UPN::Change::GetSiteId ( )
staticinherited
Returns
the applications site UPN ID, or ZERO (0) if not set.

◆ Id() [1/2]

UpnDbUpnId_t SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::Id ( ) const

Get the ID (UPN ID) of the employee.

◆ Id() [2/2]

void SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::Id ( UpnDbUpnId_t  TheId)

Set the ID of the employee.

Parameters
TheIdThe ID to use.

◆ LoadAll()

uint64_t SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::LoadAll ( UpnDbAuthHandle_t  Auth)

Load all customer records into cache.

Parameters
AuthAn authentiation handle.
Returns
The number of records loaded.

◆ Remove()

bool SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::Remove ( UpnDbAuthHandle_t  Auth)
virtual

Remove an existig UpnDbCustomer.

Parameters
AuthAn authentiation handle.
Returns
true if removed.

Implements SoftwareAndServices::Library::UPN::UpnDbRecord.

◆ SetActive()

void SoftwareAndServices::Library::UPN::Change::SetActive ( bool  IsActive)
inherited

Indicate if this record is active.

Parameters
IsActiveWhen true, this record is marked active.

◆ SetCreated() [1/2]

bool SoftwareAndServices::Library::UPN::Change::SetCreated ( String TimeOut)
inherited
Returns
The time created as a string YYYY-MM-DDTHH:MM:SS format
Parameters
TimeOutThe results of this method.
Returns
true when the time is not zero.

◆ SetCreated() [2/2]

void SoftwareAndServices::Library::UPN::Change::SetCreated ( time_t  When)
protectedinherited

Set the created time.

Parameters
WhenThe time_t of creation.

◆ SetCreatedByUpnId()

void SoftwareAndServices::Library::UPN::Change::SetCreatedByUpnId ( UpnDbUpnId_t  Creator)
inherited

Set the created by UPN ID.

Parameters
CreatorThe UPN ID of the creator of the record.

◆ SetHasChanged()

void SoftwareAndServices::Library::UPN::Change::SetHasChanged ( bool  ItChanged)
protectedinherited

Set change state.

Parameters
ItChangedWhen true, indicate this record has changed.

◆ SetSiteId()

static void SoftwareAndServices::Library::UPN::Change::SetSiteId ( UpnDbAuthHandle_t  Auth,
UpnDbUpnId_t  SiteUpnId 
)
staticinherited

Set the applications SITE ID.

Must me a memember of the authentication credentials realm, or the authentication credentials are an administrator for that realm.

Parameters
AuthThe authentication handle.
SiteUpnIdThe site's UPN ID.

◆ Update()

bool SoftwareAndServices::Library::UPN::UpnDbCustomerRecord::Update ( UpnDbAuthHandle_t  Auth) const
virtual

Update an existig UpnDbCustomer.

Parameters
AuthAn authentiation handle.
Returns
true if saved.

Implements SoftwareAndServices::Library::UPN::UpnDbRecord.


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