Skip to main content

Interface IVersionManager

Defines the contract for managing version compatibility and dependency validation in the Xperiflow system.

Namespace: Workspace.XBR.Xperiflow.VersionManagement

Assembly: Xperiflow.dll

Declaration
public interface IVersionManager

Examples

Basic usage example:

var versionManager = new VersionManager(sessionInfo, dependencies);
var result = versionManager.CheckAllDependencies();

if (!result.IsCompatible)
`{
Console.WriteLine($"Compatibility issue: {result.Message}`");
}

Remarks

The Workspace.XBR.Xperiflow.VersionManagement.IVersionManager provides centralized version management functionality for the Xperiflow system, ensuring that all dependencies are compatible and properly validated before system operations proceed.

Key Responsibilities:

  • Dependency ValidationValidates that all system dependencies meet compatibility requirements

  • Version CheckingPerforms comprehensive version compatibility checks across components

  • Error ReportingProvides detailed feedback on dependency issues and compatibility problems

Implementation Notes:

Implementations should prioritize dependencies by importance and return the first critical failure encountered. The validation process should be efficient and provide clear, actionable feedback when compatibility issues are detected.

Methods

CheckAllDependencies()

Validates the compatibility of all registered dependencies.

Declaration
VersionValidationResponse CheckAllDependencies()
Remarks

This method performs a comprehensive check of all registered dependencies to ensure they are compatible with the current system configuration. Dependencies are evaluated in priority order, and the first incompatible dependency encountered will cause the validation to fail.

If all dependencies are compatible, the method returns a successful validation response. If any dependency fails validation, the method returns a failure response with detailed information about the first incompatible dependency.

Returns

Workspace.XBR.Xperiflow.VersionManagement.VersionValidationResponse

A Workspace.XBR.Xperiflow.VersionManagement.VersionValidationResponse indicating whether all dependencies are compatible and providing details about any compatibility issues.

Exceptions

System.Exception Thrown when an error occurs during dependency validation

Was this page helpful?