PollingListProvider<TBusinessObject> Class

Article
09/23/2016

Represents a ListProvider<TBusinessObject> that polls for data at regular intervals.

Namespace: Microsoft.WindowsServerSolutions.Administration.ObjectModel
Assembly: Microsoft.WindowsServerSolutions.Administration.ObjectModel (in Microsoft.WindowsServerSolutions.Administration.ObjectModel.dll)

Inheritance Hierarchy

System.Object
System.MarshalByRefObject
Microsoft.WindowsServerSolutions.Administration.ObjectModel.ListProvider<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.PollingListProvider<TBusinessObject>

Syntax

public abstract class PollingListProvider<TBusinessObject> : ListProvider<TBusinessObject>, 
    IDisposable
where TBusinessObject : class

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class PollingListProvider abstract : ListProvider<TBusinessObject>, 
    IDisposable

Public MustInherit Class PollingListProvider(Of TBusinessObject As Class)
    Inherits ListProvider(Of TBusinessObject)
    Implements IDisposable

Type Parameters

TBusinessObject
Represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in the business object is exposed as properties.

Constructors

	Name	Description
	PollingListProvider<TBusinessObject>(TimeSpan, IEqualityComparer<TBusinessObject>)	Initializes a new instance of the PollingListProvider<TBusinessObject> class with the specified TimeSpan object and the specified IEqualityComparer<T> object.
	PollingListProvider<TBusinessObject>(TimeSpan, ListColumnCollection<TBusinessObject>)	Initializes a new instance of the PollingListProvider<TBusinessObject> class with the specified TimeSpan object and the specified ListColumnCollection<TBusinessObject>.

Properties

	Name	Description
	Errors	Gets the ErrorManager object that is used to display the errors that occurred during the data retrieval process.(Inherited from ListProvider<TBusinessObject>.)
	IsMutipleSelection	Gets or sets a value that determines if the current instance is a multiple selection.(Inherited from ListProvider<TBusinessObject>.)

Methods

	Name	Description
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Dispose()	Releases all resources used by the ListProvider<TBusinessObject> object.(Inherited from ListProvider<TBusinessObject>.)
	Dispose(Boolean)	Releases the unmanaged resources used by the PollingListProvider<TBusinessObject> object and optionally releases the managed resources.(Overrides ListProvider<TBusinessObject>.Dispose(Boolean).)
	DisposeData(IList<TBusinessObject>)	Called by the Dashboard when the data in the list pane is no longer needed.
	Equals(Object)	(Inherited from Object.)
	Filter(Object, String)	Filters using the specified business object and filter string.(Inherited from ListProvider<TBusinessObject>.)
	Finalize()	Releases unmanaged resources and performs other cleanup operations before the ListProvider<TBusinessObject> object is reclaimed by garbage collection.(Inherited from ListProvider<TBusinessObject>.)
	GetData()	Retrieves business objects and stores them in the ICollection<T> object that is returned.
	GetFilterConfig()	Retrieves the filter config.(Inherited from ListProvider<TBusinessObject>.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetObjectDisplayName(TBusinessObject)	Returns the name of the specified object that will be displayed on the page in the Dashboard.(Inherited from ListProvider<TBusinessObject>.)
	GetObjectIcon(TBusinessObject)	Returns the icon that is displayed for the specified object on the page of the Dashboard.(Inherited from ListProvider<TBusinessObject>.)
	GetObjectId(TBusinessObject)	Returns the identifier for the specified object.(Inherited from ListProvider<TBusinessObject>.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	OnDataUpdated(DataUpdatedEventArgs<TBusinessObject>)	Raises the DataUpdated event.
	RefreshAndListenForUpdates(IList<TBusinessObject>)	Called by the Dashboard when a request is made to refresh the list that is displayed in the list pane.(Overrides ListProvider<TBusinessObject>.RefreshAndListenForUpdates(IList<TBusinessObject>).)
	RefreshData()	Instructs the PollingListProvider<TBusinessObject> to poll for data.
	StopListeningForUpdates()	Called to stop the Dashboard from listening for list updates and to relinquish control of the IList that was passed into RefreshAndListenForUpdates.(Overrides ListProvider<TBusinessObject>.StopListeningForUpdates().)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	DataUpdated	Represents an event that is raised when new data is available.

Remarks

Implementing a PollingListProvider<TBusinessObject> is useful if the underlying data source does not support event-driven change notification.

TBusinessObject represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in the business object is exposed as properties.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via