Account Settings Service (IAccountSettingsService) Interface

Namespace: Cxt.Account.Settings.API.Abstractions

The IAccountSettingsService interface defines the contract for services that handle the business logic related to managing client account visibility settings. It outlines the primary operations that any implementing service class must provide.

This interface is crucial for decoupling the API controller from the concrete service implementation, allowing for easier testing and maintenance.

Purpose

To provide a standardized set of operations for:

• Adding new account visibility preferences for a client.
• Updating existing account visibility preferences.
• Deleting specific account visibility preferences.
• Retrieving a client's current account visibility preferences.

Methods

Add Client Account Settings Preferences Service

Task<bool> AddClientAccountSettingsPreferencesService(AccountSettingsAddRequest request, CancellationToken cancellationToken);

• Description: Adds or updates account settings preferences for a client based on the provided request.
• Parameters:

  Parameter	Type	Description
  request	AccountSettingsAddRequest	An AccountSettingsAddRequest object containing the client's GCN, business unit, and the list of accounts with their visibility settings.
  cancellationToken	CancellationToken	A CancellationToken to observe while waiting for the task to complete, allowing the operation to be cancelled.

• Returns: Task<bool> - true if the operation was successful, false otherwise.

Update Client Account Settings Preferences Service

Task<bool> UpdateClientAccountSettingsPreferencesService(AccountSettingsUpdateRequest request, CancellationToken cancellationToken);

• Description: Updates existing account settings preferences for a client.
• Parameters:

  Parameter	Type	Description
  request	AccountSettingsUpdateRequest	An AccountSettingsUpdateRequest object containing the details of the preferences to be updated.
  cancellationToken	CancellationToken	A CancellationToken.

• Returns: Task<bool> - true if the update was successful, false otherwise.

Delete Client Account Settings Preferences Service

Task<bool> DeleteClientAccountSettingsPreferencesService(AccountSettingsDeleteRequest request, CancellationToken cancellationToken);

• Description: Deletes a specific account setting preference for a client.
• Parameters:

  Parameter	Type	Description
  request	AccountSettingsDeleteRequest	An AccountSettingsDeleteRequest object specifying the GCN, account number, and account type of the preference to delete.
  cancellationToken	CancellationToken	A CancellationToken.

• Returns: Task<bool> - true if the deletion was successful, false otherwise.

Retrieve Client Account Settings Preferences Service

Task<AccountSettingsResponse> RetrieveClientAccountSettingsPreferencesService(string gcn, CancellationToken cancellationToken);

• Description: Retrieves the account settings preferences for a client identified by their GCN.
• Parameters:

  Parameter	Type	Description
  gcn	string	A string representing the Global Client Number.
  cancellationToken	CancellationToken	A CancellationToken.

• Returns: Task<AccountSettingsResponse> - An AccountSettingsResponse object containing the client's preferences. If no settings are found, the response object might be empty or specific properties within it (like ProfileAccounts) might be null or empty, depending on the implementation.

Consumers

• The primary consumer of this interface is the AccountSettingsController (see Account Settings Controller), which uses an instance of a class implementing IAccountSettingsService (like AccountSettingsService Class) to perform the actual operations.

This interface plays a key role in the API's architecture by abstracting the core business logic for account settings management.