core::domain::policies::annual Namespace Reference

Classes
class	AnnualValidationIssue
class	AnnualValidationResult

Functions
bool	isValidYear (int year)
	Checks whether a year is valid for annual aggregates.
bool	isValidAnnual (int year, const std::vector< std::string > &analysisIds)
	Checks whether an annual aggregate is structurally valid.
std::string	normalizeId (std::string value)
	Trims leading and trailing whitespace from an id.
bool	containsAnalysisId (const std::vector< std::string > &analysisIds, const std::string &analysisId)
	Checks whether an analysis id exists in a list.
bool	hasUniqueAnalysisIds (const std::vector< std::string > &analysisIds)
	Checks whether all analysis ids are unique.
bool	containsAllAnalysisIds (const std::vector< std::string > &analysisIds, const std::vector< std::string > &requiredIds)
	Checks whether a list contains all required analysis ids.
void	normalizeIds (std::vector< std::string > &values)
	Normalizes and deduplicates analysis ids.
std::optional< int >	extractBookingYear (const std::string &bookingDate)
	Extracts the year component from a booking date.
AnnualValidationResult	validateTransactionsForYear (int year, const std::vector< std::shared_ptr< core::domain::Transaction > > &transactions)
	Validates that transaction booking years match the annual year.

Function Documentation

containsAllAnalysisIds()

bool core::domain::policies::annual::containsAllAnalysisIds	(	const std::vector< std::string > &	analysisIds,
		const std::vector< std::string > &	requiredIds )

Checks whether a list contains all required analysis ids.

Parameters

analysisIds	Analysis id list to inspect.
requiredIds	Required analysis ids.

Returns

true when every required id is present.

Definition at line 58 of file AnnualPolicy.cpp.

containsAnalysisId()

bool core::domain::policies::annual::containsAnalysisId	(	const std::vector< std::string > &	analysisIds,
		const std::string &	analysisId )

Checks whether an analysis id exists in a list.

Parameters

analysisIds	Analysis id list to inspect.
analysisId	Analysis id to search for.

Returns

true when the id exists.

Definition at line 41 of file AnnualPolicy.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

extractBookingYear()

std::optional< int > core::domain::policies::annual::extractBookingYear

(

const std::string &

bookingDate

)

Extracts the year component from a booking date.

Parameters

bookingDate

Raw booking date text.

Returns

Parsed year when available.

Definition at line 78 of file AnnualPolicy.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

hasUniqueAnalysisIds()

bool core::domain::policies::annual::hasUniqueAnalysisIds

(

const std::vector< std::string > &

analysisIds

)

Checks whether all analysis ids are unique.

Parameters

analysisIds

Analysis id list to inspect.

Returns

true when every non-empty id appears only once.

Definition at line 46 of file AnnualPolicy.cpp.

Here is the call graph for this function:

isValidAnnual()

bool core::domain::policies::annual::isValidAnnual	(	int	year,
		const std::vector< std::string > &	analysisIds )

Checks whether an annual aggregate is structurally valid.

Parameters

year	Raw year value.
analysisIds	Analysis id list.

Returns

true when both year and analysis ids are valid.

Definition at line 32 of file AnnualPolicy.cpp.

Here is the call graph for this function:

isValidYear()

bool core::domain::policies::annual::isValidYear

(

int

year

)

Checks whether a year is valid for annual aggregates.

Parameters

year	Raw year value.

Returns

true when the year lies within the supported range.

Definition at line 31 of file AnnualPolicy.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

normalizeId()

std::string core::domain::policies::annual::normalizeId ( std::string value )

inline

Trims leading and trailing whitespace from an id.

Parameters

value

Raw id text.

Returns

Trimmed id text or an empty string.

Definition at line 34 of file AnnualPolicy.cpp.

Here is the caller graph for this function:

normalizeIds()

void core::domain::policies::annual::normalizeIds

(

std::vector< std::string > &

values

)

Normalizes and deduplicates analysis ids.

Parameters

values

Analysis id list to mutate.

Definition at line 62 of file AnnualPolicy.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

validateTransactionsForYear()

AnnualValidationResult core::domain::policies::annual::validateTransactionsForYear	(	int	year,
		const std::vector< std::shared_ptr< core::domain::Transaction > > &	transactions )

Validates that transaction booking years match the annual year.

Parameters

year	Annual year.
transactions	Transactions to validate.

Returns

Validation result with optional issues.

Definition at line 99 of file AnnualPolicy.cpp.

Here is the call graph for this function: