Cycle object

A Cycle object represents a release cycle.

You get a Cycle reference from a CycleFactory object.

Public methods

This object supports the following methods.

Method Description

AddNode

Creates a new child node.

Syntax: Cycle.AddNode(nodeName)

Parameters:

  • nodeName. A string that represents the node name.
LockObject

Locks the object. Returns True if the object has been changed on the server.

For details, see LockObject.

NewList

Gets a list of the node's immediate children.

Syntax: NewList()

Post

Posts all changed values into database.

For details, see  Post.
Refresh

Reads saved values, overwriting values in memory.

For details, see  Refresh.
Undo

Undoes changes to field values that have not been posted.

For details, see  Undo.
UnlockObject

Unlocks the object.

For details, see UnLockObject.

Public properties

This object supports the following properties.

Property R/W Type Description

Attachments

 R Object

The AttachmentFactory object for the release. See AttachmentFactory object.

Syntax: Cycle.Attachments

AutoPost

 R/W Boolean

If true, the database is updated immediately when the field value changes.

Syntax: Cycle.AutoPost

AutoUnlock

 R/W Boolean

Indicates whether to make the item changeable to other users automatically after a Refresh or Post.

Syntax: Cycle.AutoUnlock

EndDate R/W Date

The cycle's end date.

Syntax: Cycle.EndDate

Field

 R/W Any

The value of the specified field.

Syntax: Cycle.Field[fieldName]

Parameter:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.

FieldMultiValue

 R/W Object

The MultiValue object of the specified field. See MultiValue object.

Syntax: Cycle.FieldMultiValue[fieldName]

Parameter:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.

HasAttachment

 R Boolean

Checks if the object has one or more attachments.

Syntax: Cycle.HasAttachment

ID

 R Number

The item ID.

Syntax: Cycle.ID

IsLocked

 R Boolean

Checks if the object is locked for editing.

Syntax: Cycle.IsLocked

IsLocked is set by the LockObject method and is reset by the UnlockObject method.

If the object has an AutoUnlock property and the property is set to True, IsLocked is also reset by a Post or Refresh operation.

Modified

 R Boolean

Checks if the object has been modified since last refresh or post operation. If true, the field properties on the server side are not up to date.

Syntax: Cycle.Modified

Name R/W String

The cycle's name.

Syntax: Cycle.Name

Parent R Object

The cycle's parent release folder.

Syntax: Cycle.Parent

StartDate R/W Date

The cycle's start date.

Syntax: Cycle.StartDate

TypeName

 R String

The field's type.

Syntax: Cycle.TypeName

Virtual

 R Boolean

Checks if this is a virtual item, that is, an item that does not have a corresponding database record.

Syntax: Cycle.Virtual

Back to top