Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::UPN::Change Class Reference
+ Inheritance diagram for SoftwareAndServices::Library::UPN::Change:
+ Collaboration diagram for SoftwareAndServices::Library::UPN::Change:

Public Member Functions

 Change ()
 Change() - Default Constructor. More...
 
virtual ~Change ()
 ~Change() - Destructor. More...
 
bool GetActive () const
 true when this record is active. More...
 
time_t GetCreated () const
 
UpnDbUpnId_t GetCreatedByUpnId () const
 
bool GetHasChanged () const
 
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...
 

Static Public Member Functions

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

Definition at line 39 of file Change.hpp.

Constructor & Destructor Documentation

◆ Change()

SoftwareAndServices::Library::UPN::Change::Change ( )

Change() - Default Constructor.

◆ ~Change()

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

~Change() - Destructor.

Member Function Documentation

◆ GetActive()

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

true when this record is active.

◆ GetCreated()

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

◆ GetCreatedByUpnId()

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

◆ GetHasChanged()

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

◆ GetSiteId()

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

◆ SetActive()

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

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)
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)
protected

Set the created time.

Parameters
WhenThe time_t of creation.

◆ SetCreatedByUpnId()

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

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)
protected

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 
)
static

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.

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