SelectionTask<TBusinessObject> Class

Article
09/23/2016

Represents a task that depends on the selection of a business object within the Dashboard.

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.Task
Microsoft.WindowsServerSolutions.Administration.ObjectModel.SelectionTask<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.AsyncUiTask<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.ProcessTask<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.SyncUiTask<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.UrlTask<TBusinessObject>

Syntax

public abstract class SelectionTask<TBusinessObject> : Task
where TBusinessObject : class

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class SelectionTask abstract : Task

Public MustInherit Class SelectionTask(Of TBusinessObject As Class)
    Inherits Task

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.

Properties

	Name	Description
	ConditionProvider	Gets or sets a Converter<TInput, TOutput> delegate method that is used to convert an instance of a business object to the TaskCondition<TBusinessObject> for the task.
	Description	Gets or sets the description of the Task object.(Inherited from Task.)
	DisplayName	Gets the display name of the Task object.(Inherited from Task.)
	Icon	Obsolete. Gets or sets the Icon that is associated with the Task object.(Inherited from Task.)
	ID	Gets the identifier of the task.(Inherited from Task.)
	Tag	Gets or sets an object that is used to identify the Task.(Inherited from Task.)
	TaskStatus	Gets and sets the status of the current task.(Inherited from Task.)

Methods

	Name	Description
	CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from Task.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from Task.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	Completed	Represents an event that is raised when a task either successfully or unsuccessfully completes.(Inherited from Task.)
	Started	Represents an event that is raised when the task successfully starts.(Inherited from Task.)

Remarks

Cannot be instantiated or derived from directly; use derivatives of SelectionTask<TBusinessObject>.

A TaskCondition object is used with a SelectionTask<TBusinessObject> to define how the task pertains to the selected business object.

A business object encapsulates information and methods, which relate to business data or business functionality. The information in a business object is usually exposed as properties.

Examples

The following code example shows how to define a SelectionTask<TBusinessObject> and define a TaskCondition<TBusinessObject> object for the task using a delegate method:

SelectionTask<BusinessObject> task = null;
task = new ProcessTask<BusinessObject>("Selection Task", "notepad.exe");
task.ConditionProvider = ShouldShowTask;

private static TaskCondition ShouldShowTask(BusinessObject businessObj)
{
    return businessObj.OSVersion == "Windows Vista" ?
         TaskCondition.Default : TaskCondition.NotApplicable;
}

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.