Class DeploymentFactoryBase

The base class for deployment factories.

Inheritance

System.Object

DeploymentFactoryBase

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.Applications.Deployment

Assembly: Phoenix.Abstractions.Applications.dll

Syntax

public abstract class DeploymentFactoryBase

Constructors

DeploymentFactoryBase()

Initializes a new instance of the DeploymentFactoryBase class.

Declaration

public DeploymentFactoryBase()

Properties

CanCancel

Gets a value indicating whether or not the deployment type is cancelable.

Declaration

public abstract bool CanCancel { get; }

Property Value

Type	Description
System.Boolean

CanReportProgress

Gets a value indicating whether or not the deployment type reports progress.

Declaration

public abstract bool CanReportProgress { get; }

Property Value

Type	Description
System.Boolean

ID

Gets the id for the deployment factory.

Declaration

public Guid ID { get; }

Property Value

Type	Description
System.Guid

Name

Gets the name of deployment type.

Declaration

public abstract string Name { get; }

Property Value

Type	Description
System.String

UserDescription

Gets the user description for the deployment type.

Declaration

public abstract string UserDescription { get; }

Property Value

Type	Description
System.String

Methods

CreateDeployment(IDevice, ParameterInfo[])

Calls into the derived class to create a new deployment.

Declaration

public DeploymentBase CreateDeployment(IDevice device, ParameterInfo[] deploymentParameters)

Parameters

Type	Name	Description
IDevice	device	The target device.
ParameterInfo[]	deploymentParameters	The deployment parameters.

Returns

Type	Description
DeploymentBase	A new deployment instance.

CreateDeploymentInternal(IDevice, ParameterInfo[])

Creates the deployment instance for a device with the specified parameters.

Declaration

protected abstract DeploymentBase CreateDeploymentInternal(IDevice device, ParameterInfo[] deploymentParameters)

Parameters

Type	Name	Description
IDevice	device	The target device.
ParameterInfo[]	deploymentParameters	The deployment parameters.

Returns

Type	Description
DeploymentBase	A new deployment instance.

GetDefaultParameters()

Gets the default parameters for the deployment type.

Declaration

public abstract ParameterInfo[] GetDefaultParameters()

Returns

Type	Description
ParameterInfo[]	The default parameters.

GetSupportedDevices()

Gets the supported devices for the deployment type.

Declaration

public abstract IList<string> GetSupportedDevices()

Returns

Type	Description
System.Collections.Generic.IList<System.String>	The supported devices

ValidateDeploymentParameters(ParameterInfo[])

Validates the deployment parameters.

Declaration

public abstract bool ValidateDeploymentParameters(ParameterInfo[] deploymentParameters)

Parameters

Type	Name	Description
ParameterInfo[]	deploymentParameters	The deployment parameters to validate.

Returns

Type	Description
System.Boolean	Whether or not the parameters are valid.

Events

DeploymentCreated

The event for when a deployment is created.

Declaration

public event DeploymentFactoryBase.DeploymentCreatedHandler DeploymentCreated

Event Type

Type	Description
DeploymentFactoryBase.DeploymentCreatedHandler