Freeze |
public class FreezeForecastServiceArguments : IProjectOperationsServiceArguments
The FreezeForecastServiceArguments type exposes the following members.
| Name | Description | |
|---|---|---|
| Criteria |
The criteria to use for the freeze forecast process.
Default is 'Total Project'.
The available criteria will change based on the project and the terms and codes defined on the project.
Some typical criteria include:
* Total Project
* Control Account (the Control Account term)
* Work Package (the Work Package term)
To see the list of criteria you can specify, access the Cobra Help System, navigate to Tools » API » API Script » Process Sections, and locate the relevant Cobra process. | |
| ForecastCostSet | Forecast cost set to freeze Required | |
| FrozenForecastClass | Frozen forecast class to copy the forecast Required | |
| IncludeChildren | Determines whether the freeze forecast process will include child elements of the selected criterion. Optional. Default is false. | |
| Log | Determines the comment, change number and 'significant' setting for changes that affect the log. See ProjectAuditLogDescription. | |
| Project | The project to freeze forecast. Required. | |
| Selection | The criteria filter that controls the portion of the project to freeze forecast. The selection must be consistent with the Criteria setting. Multiple criteria selection can be given as comma separated value - 1.1.1.1 / 1410 / 01,1.1.1.1 / 1410 / 02 Ignored if Criteria is set to Total Project. Required for all other Criteria values. Examples: * If Criteria = "Control Account", use a Control Account key value: 1.1.1.1 / 1410; for multiple values: 1.1.1.1 / 1410,1.1.1.2 / 1420 * If Criteria = "Work Package", use a Work Package value: 1.1.1.1 / 1410 / 01; for multiple values: 1.1.1.1 / 1410 / 01,1.1.1.1 / 1410 / 02 |
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |