IListStep Interface

Ingeniux CMS Content Store API

Represents the information of a step/task entry in a background task to be monitored. This step has a collection of substeps.

Substeps need not have a particular order. List steps can advance from one step to any other step.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

public interface IListStep : IStepWithWeight, 
	IStep

Public Interface IListStep
	Inherits IStepWithWeight, IStep

public interface class IListStep : IStepWithWeight, 
	IStep

type IListStep =  
    interface
        interface IStepWithWeight
        interface IStep
    end

The IListStep type exposes the following members.

Properties

	Name	Description
	Count	Gets the count of substeps.
	Description	Gets the description of the step. (Inherited from IStep.)
	Error	Gets the error message of the step. (Inherited from IStep.)
	ID	Gets the identifier of the step. (Inherited from IStep.)
	Name	Gets the name of the step. (Inherited from IStep.)
	OngoingStep	Gets the ongoing substep. Returns null if this step is not started.
	PercentCompleted	Gets the percentage of substeps that are in the COMPLETED state.
	State	Gets the state of the step. (Inherited from IStep.)
	StepsCompleted	Gets the number of substeps that are on COMPLETED state.
	Weight	Gets the weight of this step. (Inherited from IStepWithWeight.)

Methods

	Name	Description
	Add	Adds a new sub step.
	AdvanceStep	Advance to the specified target step. Target step can be in any state, even a completed state. The specified step is the Ongoing Step. Its state is marked as ON_GOING. If the list step itself hasn't started, it will be started. Otherwise, the ongoing step is marked as COMPLETED.
	Begin	Changes the step's state to ON_GOING. (Inherited from IStep.)
	Clear	Clears substeps.
	Complete	Changes the step's state to COMPLETED. (Inherited from IStep.)
	CompleteWithError	Changes the step's state to COMPLETED, but includes an error message; this is not a successful completion. (Inherited from IStep.)
	Remove	Removes a substep.
	Step(Int32)	Retrieves a substep by its order index.
	Step(String)	Retrieves a substep by its unique ID.
	Steps	Retrieves the substeps of this step.