Interface IDataSetView

Defines the interface for a View

Namespace: STAIExtensions.Abstractions.Views

Assembly: STAIExtensions.Abstractions.dll

Syntax

public interface IDataSetView

Properties

ExpiryDate

Gets the calculated Expiry date of the view

Declaration

DateTime? ExpiryDate { get; }

Property Value

Type	Description
System.Nullable<DateTime>

FriendlyViewTypeName

Gets the fully qualified type name of the view

Declaration

string FriendlyViewTypeName { get; }

Property Value

Type	Description
System.String

Id

Gets the Auto Generated Id of the View

Declaration

string Id { get; }

Property Value

Type	Description
System.String

LastUpdate

Gets the last time the View was updated

Declaration

DateTime? LastUpdate { get; }

Property Value

Type	Description
System.Nullable<DateTime>

OwnerId

Gets or sets the Owner Id of the View

Declaration

string OwnerId { get; set; }

Property Value

Type	Description
System.String

RefreshEnabled

Gets a value indicating if the View is frozen for updates

Declaration

bool RefreshEnabled { get; }

Property Value

Type	Description
System.Boolean

SlidingExpiration

Gets or sets the Sliding Expiration of the view for expiry

Declaration

TimeSpan SlidingExpiration { get; set; }

Property Value

Type	Description
TimeSpan

ViewParameterDescriptors

Gets the allowed parameters description that this view accepts

Declaration

IEnumerable<DataSetViewParameterDescriptor>? ViewParameterDescriptors { get; }

Property Value

Type	Description
System.Nullable<IEnumerable<DataSetViewParameterDescriptor>>

ViewTypeName

Gets the fully qualified type name of the view

Declaration

string ViewTypeName { get; }

Property Value

Type	Description
System.String

Methods

SetExpiryDate()

Calculates the Next expiry time from the sliding expiry time span

Declaration

void SetExpiryDate()

SetExpiryDate(DateTime)

Explicitly set the expiry date of the view

Declaration

void SetExpiryDate(DateTime value)

Parameters

Type	Name	Description
DateTime	value	An absolute expiry date

SetViewParameters(Nullable<Dictionary<String, Object>>)

Sets the view parameters

Declaration

void SetViewParameters(Dictionary<string, object>? parameters)

Parameters

Type	Name	Description
System.Nullable<Dictionary<System.String, System.Object>>	parameters

SetViewRefreshDisabled()

Un-Freezes the view for further updates

Declaration

void SetViewRefreshDisabled()

SetViewRefreshEnabled()

Freezes the view for further updates

Declaration

void SetViewRefreshEnabled()

UpdateViewFromDataSet(IDataSet)

Updates the View from a DataSet

Declaration

Task UpdateViewFromDataSet(IDataSet dataset)

Parameters

Type	Name	Description
IDataSet	dataset	The DataSet to use as a source to update the view from

Returns

Type	Description
Task

Events

OnViewUpdated

Callback event when a view has been updated by DataSets

Declaration

event EventHandler OnViewUpdated

Event Type

Type	Description
EventHandler