RecalculateServiceArguments Class

Note: This API is now obsolete.

Contains options to run Recalculate.

Inheritance Hierarchy

SystemObject
  SerializableObjects
    ProjectOperationsServiceArguments
      Cobra.WebService.ClientAPI.Application.FilesRecalculateServiceArguments

Namespace: Cobra.WebService.ClientAPI.Application.Files
Assembly: Cobra.WebService.ClientAPI (in Cobra.WebService.ClientAPI.dll) Version: 8.4.717.3176 (8.4.0717.3176)

Syntax

Copy

[SerializableAttribute]
[ObsoleteAttribute("Use Cobra.Model.WebService.RecalculateServiceArguments instead.")]
public class RecalculateServiceArguments : ProjectOperationsServiceArguments

The RecalculateServiceArguments type exposes the following members.

Constructors

	Name	Description
	RecalculateServiceArguments	Initializes a new instance of RecalculateServiceArguments class.

Top

Properties

	Name	Description
	AllowComplete	Determines whether completed control accounts and work packages or recalculated. Optional. Default is false.
	AllowReadOnlyClasses	Determines whether read-only classes or recalculated. Optional. Default is false.
	ClassList	The list of cost classes that will be recalculated. Required.
	Criteria	The criteria to use for the recalculate 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) * WBS (the name given to the CA1 key field) * OBS (the name given to the CA2 key field) * WP (the name given to the WP key field) * Resource * Resource Assignment * CAM (the Control Account Manager term)
	EndDateLabel	The calendar set 00 label of the last period to recalculate. Optional. This EndDateLabel is only used if PeriodFilter is set to DateRange
	IncludeChildren	Determines whether the recalculate 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.
	PeriodFilter	The period range to recalculate. Optional. Default is All so all periods are recalcualted. If DateRange is used, the StartDateLabel and EndDateLabel values must be specified.
	Project	The project that will be recalculated. Required.
	ResultList	The list of the Results to recalculate. Required.
	Selection	The the criteria filter that controls the portion of the project that is recalculated. The selection must be consistent with the Criteria setting. 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 / 1000 * If Criteria = "WBS", use a WBS ID: 1.2.1 * If Criteria = "Resource", use a resource ID: ASTRO * If Criteria = "Resource Assignment", use a Resource Assignment key: 1.2 / 1200 / 01 / ASTRO
	StartDateLabel	The calendar set 00 label of the first period to start recalculating. Optional. This StartDateLabel is only used if PeriodFilter is set to DateRange
	UseRateOfOneForMissingRate	Determines whether a rate of 1 will be used instead of 0 when a rate is not found. Optional. Default is false (and a rate of 0 will be used when a rate is not found).

Top

Methods

	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.)

Top

Reference

Cobra.WebService.ClientAPI.Application.Files Namespace