Interface ITablesProvider

Namespace

Acuit.Pinpoint.Workstation.Tables

Assembly

Acuit.Pinpoint.Workstation.Interfaces.dll

A service providing access to Acuit Pinpoint Server tables.

[Obsolete("This is deprecated and will be removed in a future version; Acuit.Pinpoint.Workstation.ResourceManagement.TableResourceExtensions.CreateTableResourceReference should be used instead.")]
public interface ITablesProvider

Methods

GetTable(string, bool)

Gets a table.

Table GetTable(string tableName, bool hasHeaderRow)

Parameters

tableName string

The name of the table.

hasHeaderRow bool

Whether the table data has a header row.

Returns

Table

The table.

Remarks

Table data retrieved from Acuit Pinpoint Server is cached for fifteen minutes. This will immediately return cached data, if available; otherwise, it will retrieve the table data from Acuit Pinpoint Server before returning the table. Callers should note that this could sometimes take a long time.

The table data should not be changed, since only one copy of the table is maintained for all clients to share. If a client wants to modify the table, it should make a copy first.

Exceptions

ArgumentNullException

tableName is null.

CommunicationException

A communication error occurred while attempting to communicate with Acuit Pinpoint Server, or tableName does not refer to an existing table.

TimeoutException

Timed out while attempting to communicate with Acuit Pinpoint Server.

Exception

An error occurred while parsing the table data.

GetTableAsync(string, bool)

Gets a table.

Task<Table> GetTableAsync(string tableName, bool hasHeaderRow)

Parameters

tableName string

The name of the table.

hasHeaderRow bool

Whether the table data has a header row.

Returns

Task<Table>

A task that represents the asynchronous operation. The value of its Result property contains the table.

Remarks

Table data retrieved from Acuit Pinpoint Server is cached for fifteen minutes. This will immediately return cached data, if available; otherwise, it will retrieve the table data from Acuit Pinpoint Server before returning the table.

The table data should not be changed, since only one copy of the table is maintained for all clients to share. If a client wants to modify the table, it should make a copy first.

Exceptions

ArgumentNullException

tableName is null.

CommunicationException

A communication error occurred while attempting to communicate with Acuit Pinpoint Server, or tableName does not refer to an existing table. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

TimeoutException

Timed out while attempting to communicate with Acuit Pinpoint Server. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

Exception

An error occurred while parsing the table data. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.