ECompaniesConfig Class Reference

Class represent functionality based on configuration file 'CompaniesConfig.xml'. More...

#include <ECompaniesConfig.h>

Inheritance diagram for ECompaniesConfig:

Collaboration diagram for ECompaniesConfig:

Public Member Functions
	ECompaniesConfig ()
	Creates data class acorporateNumbernd call LoadParam. More...
	~ECompaniesConfig ()
	Destroy data class. More...
long	IsHomeCompany (unsigned short departmentCompanyNumber, bool &isHomeCompany) const
	Function checks whether department number departmentNumber is same as home company corporate number homeCompanyNumber. More...
bool	GetCorporateNumberViaCompanyNumber (unsigned long departmentNumber, unsigned long &corporateNumber) const
	Function get corporate number by company number. Corporate number return by output parameter corporateNumber. More...
bool	GetCorporateNumberViaCompanyNumber (unsigned long departmentNumber, std::list< long > &corporateNumber) const
bool	GetDepartmentName (unsigned long departmentNumber, std::string &departmentName)
	Function get corporate name by corporate number. Corporate name return by output parameter corporateName. More...
bool	ReadConfiguration (std::string customConfigPath)
	Function provides the possibility to read config file from custom/not standard path. More...
	ECompaniesConfig ()
	Creates data class acorporateNumbernd call LoadParam. More...
	~ECompaniesConfig ()
	Destroy data class. More...
long	IsHomeCompany (unsigned short departmentCompanyNumber, bool &isHomeCompany) const
	Function checks whether department number departmentNumber is same as home company corporate number homeCompanyNumber. More...
bool	GetCorporateNumberViaCompanyNumber (unsigned long departmentNumber, unsigned long &corporateNumber) const
	Function get corporate number by company number. Corporate number return by output parameter corporateNumber. More...
bool	GetCorporateNumberViaCompanyNumber (unsigned long departmentNumber, std::list< long > &corporateNumber) const
bool	GetDepartmentName (unsigned long departmentNumber, std::string &departmentName)
	Function get corporate name by corporate number. Corporate name return by output parameter corporateName. More...
bool	ReadConfiguration (std::string customConfigPath)
	Function provides the possibility to read config file from custom/not standard path. More...

Detailed Description

Class represent functionality based on configuration file 'CompaniesConfig.xml'.

Class Functionality :

• find corporate number. GetCorporateNumber
• check if selected company number is domestic company or external company. CheckHomeCompany

Constructor & Destructor Documentation

INTERNAL ECompaniesConfig::ECompaniesConfig

(

)

Creates data class acorporateNumbernd call LoadParam.

CONSTRUCTOR

ECompaniesConfig::~ECompaniesConfig

(

)

Destroy data class.

DESTRUCTOR

ECompaniesConfig::ECompaniesConfig

(

)

Creates data class acorporateNumbernd call LoadParam.

ECompaniesConfig::~ECompaniesConfig

(

)

Destroy data class.

Member Function Documentation

bool ECompaniesConfig::GetCorporateNumberViaCompanyNumber	(	unsigned long	departmentCompanyNumber,
		unsigned long &	corporateNumber
	)		const

Function get corporate number by company number. Corporate number return by output parameter corporateNumber.

Parameters

departmentNumber	- Corporate number will be found by this param
corporateNumber	- output parameter, founded corporate number

Returns

true - sucessfully processed, false otherwise

GetCorporateNumberViaCompanyNumber

bool ECompaniesConfig::GetCorporateNumberViaCompanyNumber	(	unsigned long	departmentNumber,
		unsigned long &	corporateNumber
	)		const

Function get corporate number by company number. Corporate number return by output parameter corporateNumber.

Parameters

departmentNumber	- Corporate number will be found by this param
corporateNumber	- output parameter, founded corporate number

Returns

true - sucessfully processed, false otherwise

bool ECompaniesConfig::GetCorporateNumberViaCompanyNumber	(	unsigned long	departmentNumber,
		std::list< long > &	corporateNumber
	)		const

bool ECompaniesConfig::GetCorporateNumberViaCompanyNumber	(	unsigned long	departmentNumber,
		std::list< long > &	corporateNumber
	)		const

bool ECompaniesConfig::GetDepartmentName	(	unsigned long	departmentNumber,
		std::string &	departmentName
	)

Function get corporate name by corporate number. Corporate name return by output parameter corporateName.

Parameters

corporateNumber	- identificator of corporate
corporateName	- output parameter, founded corporate name

Returns

true - sucessfully processed, false otherwise

bool ECompaniesConfig::GetDepartmentName	(	unsigned long	departmentNumber,
		std::string &	departmentName
	)

Function get corporate name by corporate number. Corporate name return by output parameter corporateName.

Parameters

corporateNumber	- identificator of corporate
corporateName	- output parameter, founded corporate name

Returns

true - sucessfully processed, false otherwise

long ECompaniesConfig::IsHomeCompany	(	unsigned short	departmentCompanyNumber,
		bool &	isHomeCompany
	)		const

Function checks whether department number departmentNumber is same as home company corporate number homeCompanyNumber.

Parameters

departmentNumber	- selected department number
IsHomeCompany	- this output parameter is true when department number is in home corporate, false otherwise

Returns

EDATA_ERR_BAD_COMPANIES_CONFIG_DATA - error get home or department corporate number EDATA_OK - all ok

long ECompaniesConfig::IsHomeCompany	(	unsigned short	departmentCompanyNumber,
		bool &	isHomeCompany
	)		const

Function checks whether department number departmentNumber is same as home company corporate number homeCompanyNumber.

Parameters

departmentNumber	- selected department number
IsHomeCompany	- this output parameter is true when department number is in home corporate, false otherwise

Returns

EDATA_ERR_BAD_COMPANIES_CONFIG_DATA - error get home or department corporate number EDATA_OK - all ok

Here is the call graph for this function:

bool ECompaniesConfig::ReadConfiguration

(

std::string

customConfigPath

)

Function provides the possibility to read config file from custom/not standard path.

Parameters

customConfigPath

- custom path to configuration file

Returns

true - sucessfully processed, false otherwise

bool ECompaniesConfig::ReadConfiguration

(

std::string

customConfigPath

)

Function provides the possibility to read config file from custom/not standard path.

Parameters

customConfigPath

- custom path to configuration file

Returns

true - sucessfully processed, false otherwise

---

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

• src/dataio/datainputlogic/ECompaniesConfig.h
• src/dataio/datainputlogic/ECompaniesConfig.cpp