RespreadServiceArguments Class

Note: This API is now obsolete.

Contains options to run Respread.

Inheritance Hierarchy

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

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.RespreadServiceArguments instead.")]
public class RespreadServiceArguments : ProjectOperationsServiceArguments

The RespreadServiceArguments type exposes the following members.

Constructors

	Name	Description
	RespreadServiceArguments	Intializes a new instance of RespreadServiceArguments

Top

Properties

	Name	Description
	AllowInProgress	Determines whether in-progress control accounts and work packages are respread. Optional. Default is false.
	ClassList	The list of cost classes that will be respread. Required.
	Criteria	The criteria to use for the respread 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)
	IncludeChildren	Determines whether the respread 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	Determines whether the respread process will include child elements of the selected criterion. Optional. Default is false.
	Project	The project that will be respread.
	Selection	The the criteria filter that controls the portion of the project that is respread. 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

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