Class: ActivityPlan

ActivityPlan(data)

Class representing doing an Activity: a plan for executing an Activity to do something specific.

Constructor

new ActivityPlan(data)

Constructs an ActivityPlan object
Parameters:
Name Type Description
data ActivityPlan | Object
Source:

Members

_id :string

Unique ID for the Activity Plan
Type:
  • string
Default Value:
  • ''
Source:

activityKey :ActivityKey|string

Key of the Activity that this Activity Plan is a plan for
Type:
Default Value:
  • ''
Source:

activityPlanNumber :number

Number of this Activity Plan. This number is unique for all users on a desktop installation.
Type:
  • number
Source:

activityPlanTitle :string

Title of the Activity Plan
Type:
  • string
Default Value:
  • ''
Source:

nextTaskIndex :number

index into this Activity Plan's 'tasks' array of the next task waiting to be done
Type:
  • number
Source:

notes :string

Notes for this Activity Plan
Type:
  • string
Default Value:
  • ''
Source:

syncedTaskIndex :number

index of the last completed task that was synced. When syncing, syncedTaskIndex is set to nextTaskIndex - 1.
Type:
  • number
Source:

tasks :Array.<Task>

The sequence of steps to follow to complete this Activity Plan. Initially, these tasks will be created from the Activity corresponding to activityKey. The user may add, delete, or edit this list of tasks for this Activity Plan.
Type:
Source:

unitCompleted :number|null

The overall CLA unit the user was in when he completed this ActivityPlan (see User.claUnit)
Type:
  • number | null
Default Value:
  • null
Source:

unitCreated :number|null

The overall CLA unit the user was in when he created this ActivityPlan (see User.claUnit)
Type:
  • number | null
Default Value:
  • null
Source:

Methods

set(data) → {ActivityPlan}

Creates an updated ActivityPlan object
Parameters:
Name Type Description
data ActivityPlan | Object
Source:
Returns:
Type
ActivityPlan