IStepWithWeight Interface |
Represents the information of a step/task entry in a background task to be monitored.
By default, a step has one unit of weight in its Task Monitor. A step with weight can take multiple weight units.
However, the units cannot be equal to or less than 0.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IStepWithWeight type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | 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.) |
| State |
Gets the state of the step.
(Inherited from IStep.) |
| Weight |
Gets the weight of this step.
|
Methods| Name | Description | |
|---|---|---|
 | Begin |
Changes the step's state to ON_GOING.
(Inherited from IStep.) |
| 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.) |
See Also