Class ReportingFacade

Namespace
SWConfigDataClientLib.Proxies.Reporting
Assembly
IpPbxCDSClientLib.dll

Facade class for reporting client applications.

public class ReportingFacade : ReportingFacadeBase
Inheritance
SWCFProxy<ReportingFacadeClient, IReportingFacade>
ReportingFacade
Inherited Members

Constructors

ReportingFacade()

Creates instance of ReportingFacade. (For use by Unmanaged Wrapper only)

public ReportingFacade()

Remarks

Use the LibManager to create an instance of this class.

Properties

PoolMaxSize

depcreated

public static int PoolMaxSize { get; set; }

Property Value

int

PoolMinSize

depcreated

public static int PoolMinSize { get; set; }

Property Value

int

m_BaseUrl 

protected override string m_BaseUrl { get; }

Property Value

string

Methods

CheckVersion() 

public void CheckVersion()

CreateClient(Binding, EndpointAddress) 

protected override ReportingFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

ReportingFacadeClient

CreateMissingAccountings(DateTime, int) 

public void CreateMissingAccountings(DateTime since, int days)

Parameters

since DateTime
days int

CreateReport(ReportType, Guid, SDateTime, SDateTime)

Create and send a manual report. The report will not be stored in the database.

public void CreateReport(ReportType ReportType, Guid Reseller, SDateTime PeriodBegin, SDateTime PeriodEnd)

Parameters

ReportType ReportType

Report type. Must be 1 (ReportType.ForInfo) to obtain a manual report.

Reseller Guid

The reseller for which to generate the report. If there is only 1 reseller configured you may provide Guid.Empty.

PeriodBegin SDateTime

The start of the reporting period. This parameter will be ignored as the start time will always be the end time of the last automatic report.

PeriodEnd SDateTime

The end of the reporting period. This parameter will be ignored as the end time will always be the current time.

Dispose() 

public virtual void Dispose()

FreeForReuse() 

public override void FreeForReuse()

GenerateReports(bool)

GenerateReports Test method

public void GenerateReports(bool bAutomatic)

Parameters

bAutomatic bool

GetCompleteHSWClientList()

Retrieves a read only collection with all clients. Deactivated client are included!

public ClientPrimaryCollection GetCompleteHSWClientList()

Returns

ClientPrimaryCollection

A ReportListPrimaryCollection

GetCompleteReportList()

Retrieves a read only collection with all reports.

public ReportListPrimaryCollection GetCompleteReportList()

Returns

ReportListPrimaryCollection

A ReportListPrimaryCollection

GetCompleteResellerList()

Retrieves a read only collection with all resellers. In HSW 1.0 (Albinoni) there will be always exactly one reseller (provider)

public ResellerPrimaryCollection GetCompleteResellerList()

Returns

ResellerPrimaryCollection

A ResellerPrimaryCollection

GetCurrentUserID() 

public int GetCurrentUserID()

Returns

int

GetCurrentUserName() 

public string GetCurrentUserName()

Returns

string

GetCurrentUserName(ref string) 

public int GetCurrentUserName(ref string UserName)

Parameters

UserName string

Returns

int

GetDayOfReport()

Gets the monthly day of creating and sending reports for billing

public int GetDayOfReport()

Returns

int

Day of month

GetLastReportPeriod(ReportType, out SDateTime, out SDateTime) 

public void GetLastReportPeriod(ReportType ReportType, out SDateTime PeriodBegin, out SDateTime PeriodEnd)

Parameters

ReportType ReportType
PeriodBegin SDateTime
PeriodEnd SDateTime

GetPossibleIpPbxUserNames()

Returns all possible IpPbx User Names of the current user. Can be more than one if the current user is a windows user and multiple IppPbxUser are assigned to his windows account.

public SStringList GetPossibleIpPbxUserNames()

Returns

SStringList

StringList

GetServerRequestTimeout(ReportingFacadeClient) 

protected override TimeSpan GetServerRequestTimeout(ReportingFacadeClient client)

Parameters

client ReportingFacadeClient

Returns

TimeSpan

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(ReportingFacadeClient) 

protected override void PingService(ReportingFacadeClient cProxy)

Parameters

cProxy ReportingFacadeClient

RemoveHSWClientDeactivationTime(Guid)

Removes any deactivation date for the given HSWClient. If the HSWClient is already deactivated an exception will be thrown.

public void RemoveHSWClientDeactivationTime(Guid ClientID)

Parameters

ClientID Guid

The ID of the given HSWClient

RemoveOldReportings() 

public ICollection<string> RemoveOldReportings()

Returns

ICollection<string>

RepairReportsWithoutDocuments()

GenerateReports Test method

public void RepairReportsWithoutDocuments()

ResendReport(Guid)

(Re-)send a previously generated report.

public void ResendReport(Guid ReportDocId)

Parameters

ReportDocId Guid

The report mail to send.

SetDayOfReport(int)

Sets the monthly day of creating and sending reports for billing

public void SetDayOfReport(int DayOfMonth)

Parameters

DayOfMonth int

The day

SetHSWClientDeactivationTime(Guid, SDateTime, bool)

Sets a deactivation date for the given HSWClient. A deactivated client will no longer be accounted. A deactivated HSWClient cannot register and will not allow any login. A deactivated client can never be activated again. Before a HSWClient will be deactivated, missing accountings will be added.

public void SetHSWClientDeactivationTime(Guid ClientID, SDateTime deactivationDate, bool processImidiately)

Parameters

ClientID Guid

The given ClientID

deactivationDate SDateTime

The date of the deactivation. Only the date part will be used. Time should be local server time.

processImidiately bool

If set tu true and the deactivation date is the current date, the deactivation will be done instantly. Otherwise the deactivation will happen in the next accounting phase.

SetResellerEMail(Guid, string) 

public void SetResellerEMail(Guid ResellerID, string EMailAddress)

Parameters

ResellerID Guid
EMailAddress string