using Sbroenne.ExcelMcp.ComInterop.Session;
using Sbroenne.ExcelMcp.Core.Models;
namespace Sbroenne.ExcelMcp.Core.Commands;
/// <summary>
/// Interface for connection management commands
/// </summary>
public interface IConnectionCommands
{
/// <summary>
/// Lists all connections in a workbook
/// </summary>
ConnectionListResult List(IExcelBatch batch);
/// <summary>
/// Views detailed connection information
/// </summary>
ConnectionViewResult View(IExcelBatch batch, string connectionName);
/// <summary>
/// Creates a new connection in the workbook
/// </summary>
void Create(IExcelBatch batch, string connectionName,
string connectionString, string? commandText = null, string? description = null);
/// <summary>
/// Refreshes connection data
/// </summary>
void Refresh(IExcelBatch batch, string connectionName);
/// <summary>
/// Refreshes connection data with timeout
/// </summary>
void Refresh(IExcelBatch batch, string connectionName, TimeSpan? timeout);
/// <summary>
/// Deletes a connection
/// </summary>
void Delete(IExcelBatch batch, string connectionName);
/// <summary>
/// Loads connection data to a worksheet
/// </summary>
void LoadTo(IExcelBatch batch, string connectionName, string sheetName);
/// <summary>
/// Gets connection properties
/// </summary>
ConnectionPropertiesResult GetProperties(IExcelBatch batch, string connectionName);
/// <summary>
/// Sets connection properties (connection string, command text, description, and behavior settings)
/// </summary>
void SetProperties(IExcelBatch batch, string connectionName,
string? connectionString = null, string? commandText = null, string? description = null,
bool? backgroundQuery = null, bool? refreshOnFileOpen = null,
bool? savePassword = null, int? refreshPeriod = null);
/// <summary>
/// Tests connection without refreshing data
/// </summary>
void Test(IExcelBatch batch, string connectionName);
}
