Ft.Datafangst.Utils 1.6.9

Utilities

Contains various utilities related to development of Ft.Datafangst logic.

Install or update a package to project

The dotnet add package command installs the latest version of the package unless you specify a different version.

dotnet add package Ft.Datafangst.Utils

NB! Must be in the project folder that it is to be added to!

To install a specific version of a NuGet package, use the optional -v or --version switch:

dotnet add package Ft.Datafangst.Utils --version 1.0.0

Use the dotnet remove package command to remove a package reference from the project file.

dotnet remove package Ft.Datafangst.Utils

To restore a package Open a command line and switch to the directory that contains your project file. Then run dotnet restore.

dotnet restore

ModelStateDictionaryExtension

IsConditionInError

Modifies the ModelStateEntry.Errors for the given key by either adding or removing the provided error message based on the evaluation of a condition.

• Param:
  • modelStateDic: Represents the outcome of binding values from an HTTP request to an action method. This includes associated validation details.
  • state: Condition to evaluate for determining the error state.
  • key: Identifier for the ModelStateEntry where potential errors should be added.
  • errorMsg: Message to add if the state evaluates to true.
• Return:
  • A numeric representation of the Language. Basic Example in C#

ModelStateDictionary validationResults = new ModelStateDictionary();
var key = "organisasjonsnummer";
var errorMsg = "testError";
bool conditionIsError = 2 + 1 == 4;  // Evaluates to false.
validationResults.IsConditionInError(conditionIsError, key, errorMsg);

StringExtensions

IsOrganizationNumberValid

Checks if a given string is a valid Organization (Business Registration) Number.

• Param:
  • organizationNumber: The organization (Business Registration) number to validate. This should be a 9-digit numeric string.
• Returns:
  • true if the organizationNumber is valid, otherwise false. Basic Example in C#

bool isValid = "123456789".IsOrganizationNumberValid(); // Returns true
bool isNotValid = "123".IsOrganizationNumberValid();   // Returns false

IsIsinValid

Validates whether a given string adheres to the ISIN code format.

• Param:
  • isinCode: The string representation of the ISIN code for validation.
• Returns:
  • true if the string is a valid ISIN code; otherwise, false. Basic Example in C#

bool isValid = "No1234567890"IsIsinValid());  // Returns true
bool isNotValid = "No123".IsIsinValid();          // Returns false

IsLeiValid

Validates whether the given string conforms to the Legal Entity Identifier (LEI) standard.

• Param: -lei: An LEI is a 20-character alphanumeric code that follows a specific format. (ISO 17442: The Global Standard) It consists of four parts: - Characters 1-4: Prefix used to ensure the uniqueness among codes from LEI issuers (Local Operating Units or LOUs). - Characters 5-18: Entity-specific part of the code generated and assigned by LOUs according to transparent, sound and robust allocation policies. As required by ISO 17442, it contains no embedded intelligence. - Characters 19-20: Two check digits as described in the ISO 17442 standard.
• Returns:
  • true if the LEI is valid, false otherwise. Basic Example in C#

bool isValid = "123400ABCDE7810FGH07".IsLeiValid(); // Returns true
bool isNotValid = "7ZW8QJWVPR4P1J".IsLeiValid(); // Returns false

ConvertLanguageStringToNumeric

Transforms a two-letter language code (e.g., "nb") into its corresponding numeric value. If no valid code is provided or found, it defaults to English (1033).

• Param:
  • language: Two-character language code (e.g., "nb" for Norwegian).
    • "nb": Returns 1044
    • "nn": Returns 2068
    • Any other value or null: Defaults to 1033
• Return:
  • Numeric representation of the provided language code.

Basic Example in C#

     1044 = "nb".ConvertLanguageStringToNumeric();
     1033 = null.ConvertLanguageStringToNumeric();

GetLanguageAsNumeric

Gets the language that is set up with the user profile and converts

• Param:
  • userProfile: User profile to get language form
• Return:
  • A representative numerical value for the Language.

SetPeriode

Configures the period based on the period type and optionally, the year.

• Param:
  • periodeType: A code representing specific times within a year.
    • H1: 1. Halvår
    • H2: 2. Halvår
    • Q1: 1. Kvartal
    • Q2: 2. Kvartal
    • Q3: 3. Kvartal
    • Q4: 4. Kvartal
    • M1: Januar
    • M2: Februar
    • M3: Mars
    • M4: April
    • M5: Mai
    • M6: Juni
    • M7: Juli
    • M8: August
    • M9: September
    • M10: Oktober
    • M11: November
    • M12: Desember
    • Y: År
    • O: Løpende rapportering
  • year (Optional): The specific year for the period.
• Return:
  • A string combined from the userProfile code and the year.

Basic Example in C#

     "1. halvår 2023" = "H1".SetPeriode(2023);
     "1. halvår" = "H1".SetPeriode();
     "År 2023" = null.SetPeriode("2023");
     "" = null.SetPeriode("");

StringValuesExtension

ContainsSpecificStringValue

Checks if the StringValues contains a specific string value. Typical use of this will be to check if a http header element contains a specific string

• Param:
  • stringValues: StringValues to check in.
  • containedString: Specific string value to check for
• Return:
  • Returns true if specific string value is found. Else false.

Basic Example in C#

    var stringValues = new StringValues(new[] {"4-1-RadioButtons", "4-6-1-1-RadioButtons-0-0", "4-2-1-Input"});

    true = stringValues.ContainsSpecificStringValue("4-2-1-Input");
    false = stringValues.ContainsSpecificStringValue("4-2-0-Input");

HttpContextAccessorExtension

ContainsSpecificStringValue

Checks if a HttpContextAccessor element contains a specific string value in its Header

• Param:
  • httpContextAccessor: HttpContextAccessor to check if has the value.
  • key: The String of the Key that belongs to the StringValues to check in.
  • containedString: Specific string value to check for.
• Return:
  • Returns true if specific string value is found. Else false.

Basic Example in C#

    var key = "X-ComponentId";
    var result = httpContextAccessor.Object.ContainsSpecificStringValue(key, "4-1-RadioButtons");