PollingListProvider<TBusinessObject> Class

 

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)

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

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class PollingListProvider abstract : ListProvider<TBusinessObject>, 
	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.

NameDescription
System_CAPS_protmethodPollingListProvider<TBusinessObject>(TimeSpan, IEqualityComparer<TBusinessObject>^)

Initializes a new instance of the PollingListProvider<TBusinessObject> class with the specified TimeSpan object and the specified IEqualityComparer<T> object.

System_CAPS_protmethodPollingListProvider<TBusinessObject>(TimeSpan, ListColumnCollection<TBusinessObject>^)

Initializes a new instance of the PollingListProvider<TBusinessObject> class with the specified TimeSpan object and the specified ListColumnCollection<TBusinessObject>.

NameDescription
System_CAPS_pubpropertyErrors

Gets the ErrorManager object that is used to display the errors that occurred during the data retrieval process.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_pubpropertyIsMutipleSelection

Gets or sets a value that determines if the current instance is a multiple selection.(Inherited from ListProvider<TBusinessObject>.)

NameDescription
System_CAPS_pubmethodCreateObjRef(Type^)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the ListProvider<TBusinessObject> object.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the PollingListProvider<TBusinessObject> object and optionally releases the managed resources.(Overrides ListProvider<TBusinessObject>::Dispose(Boolean).)

System_CAPS_protmethodDisposeData(IList<TBusinessObject>^)

Called by the Dashboard when the data in the list pane is no longer needed.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodFilter(Object^, String^)

Filters using the specified business object and filter string.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the ListProvider<TBusinessObject> object is reclaimed by garbage collection.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_protmethodGetData()

Retrieves business objects and stores them in the ICollection<T> object that is returned.

System_CAPS_pubmethodGetFilterConfig()

Retrieves the filter config.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetObjectDisplayName(TBusinessObject)

Returns the name of the specified object that will be displayed on the page in the Dashboard.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_protmethodGetObjectIcon(TBusinessObject)

Returns the icon that is displayed for the specified object on the page of the Dashboard.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_protmethodGetObjectId(TBusinessObject)

Returns the identifier for the specified object.(Inherited from ListProvider<TBusinessObject>.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnDataUpdated(DataUpdatedEventArgs<TBusinessObject>^)

Raises the DataUpdated event.

System_CAPS_protmethodRefreshAndListenForUpdates(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>^).)

System_CAPS_protmethodRefreshData()

Instructs the PollingListProvider<TBusinessObject> to poll for data.

System_CAPS_protmethodStopListeningForUpdates()

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().)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDataUpdated

Represents an event that is raised when new data is available.

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.

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

Return to top

Community Additions

ADD
Show: