Class: CLAFile

CLAFile(data)

Class representing a CLA File. This class is only used as a base class (super class).

Constructor

new CLAFile(data)

constructs a CLAFile instance
Parameters:
Name Type Description
data CLAFile | Object
Properties
Name Type Description
fileNumber number
imported boolean
readOnly boolean
linkedFiles Array.<string>
activityPlanId string
Source:

Members

activityPlanIds :Array.<string>

_id's of the ActivityPlans this CLA File is linked to. If empty array, this CLA File was created without an ActivityPlan. To find a specific task in an ActivityPlan that is linked to this CLA File, search through the ActivityPlan's tasks for this CLA File's _id in taskClaFileId. _id's are appended to the end of the list when this CLA File is linked to an ActivityPlan. So, the first ActivityPlan in the list is the one this CLA File was created through (or if the CLA File was not created through an Activity Plan, the first ActivityPlan this CLA File was linked to), unless the user explicitly disassociates this CLA File from that original ActivityPlan.
Type:
  • Array.<string>
Source:

canLinkToTask :boolean

if true, show this item in Pending (unless deferToStage prevents it)
Type:
  • boolean
Source:

deferToStage :number

Do not show this item in Pending until User.getClaStageNumber() of the user's CLA Stage is at least this number.
Type:
  • number
Source:

fileNumber :number

file number
Type:
  • number
Source:

imported :boolean

true if the file was imported from a previous export
Type:
  • boolean
Source:

linkedFiles :Array.<string>

Array of file numbers (not _id's)
Type:
  • Array.<string>
Default Value:
  • []
Source:

readOnly :boolean

true if we should prevent editing the file
Type:
  • boolean
Source:

Methods

claFileType()

The type of CLA File this is (e.g., CultureEvent, DRE) This method must be overridden in any class that extends CLAFile
Source:

isCE() → {boolean}

returns true if this CLAFile is a CultureEvent
Source:
Returns:
Type
boolean

isDRE() → {boolean}

returns true if this CLAFile is a DRE
Source:
Returns:
Type
boolean

isPE() → {boolean}

returns true if this CLAFile is a PE
Source:
Returns:
Type
boolean