IListStep Methods Ingeniux CMS Content Store API

The IListStep type exposes the following members.

Methods

  Name Description
Public method Add
Adds a new sub step.
Public method 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.
Public method Begin
Changes the step's state to ON_GOING.
(Inherited from IStep.)
Public method Clear
Clears substeps.
Public method Complete
Changes the step's state to COMPLETED.
(Inherited from IStep.)
Public method CompleteWithError
Changes the step's state to COMPLETED, but includes an error message; this is not a successful completion.
(Inherited from IStep.)
Public method Remove
Removes a substep.
Public method Step(Int32)
Retrieves a substep by its order index.
Public method Step(String)
Retrieves a substep by its unique ID.
Public method Steps
Retrieves the substeps of this step.
Top
See Also

Reference