ActionItem Class Methods

In this section, the ActionItem class methods are presented in alphabetical order.

Syntax

delete()

Description

Use this method to delete the current action item.

Parameters

None.

Returns

A Boolean value: True if the deletion was successful, False otherwise.

Syntax

new(item_ID, title, list_ID)

Description

Use this method to create and initialize a new action item.

Parameters

Field or Control

Definition

item_ID

Specifies the ID for the new action item as a string.

title

Specifies the title for the new action item as a string.

Note: The title is also referred to as the Label property.

list_ID

Specifies the activity guide to which the action item belongs as a string.

Returns

None.

Syntax

nextAction()

Description

Use this method to return the next detail action item in the activity guide that is assigned and is not cancelled or on hold.

Parameters

None.

Returns

An ActionItem object.

Syntax

open(item_ID)

Description

Use this method to retrieve the specified action item definition from the database and set the properties.

Parameters

Field or Control

Definition

item_ID

Specifies the action item ID as a string.

Returns

None.

Syntax

prevAction()

Description

Use this method to return the previous detail action item in the activity guide that is assigned and is not cancelled or on hold.

Parameters

None.

Returns

An ActionItem object.

Syntax

save()

Description

Use this method to save the current action item definition to the database. If this is a new activity guide, then the definition is inserted into the database; otherwise, an existing definition is updated in the database.

Parameters

None.

Returns

A Boolean value: True if the save is successful, False otherwise.