src/app/child-dev-project/notes/model/note.ts
Notes are a special in-built entity type to record free-form information related to other records.
Previously, Note has also functioned to record an event with an attendance list of participants.
That functionality is getting generalized and decoupled from this specific entity.
Add a "attendance" type field to any entity type instead.
Attendance-related fields and methods here are currently kept (deprecated) for backwards compatibility until all existing data is migrated.
No results matching.
Properties |
|
Methods |
|
| attachment |
Type : string
|
Decorators :
@DatabaseField({label: undefined, dataType: 'file'})
|
| category |
Type : InteractionType
|
Decorators :
@DatabaseField({label: undefined, dataType: 'configurable-enum', additional: INTERACTION_TYPE_CONFIG_ID, anonymize: 'retain'})
|
| childrenAttendance |
|
Attendance logic will be decoupled from Note. By default, notes will not include attendance details anymore. Any entity type can add an |
Type : AttendanceItem[]
|
Default value : []
|
Decorators :
@DatabaseField({anonymize: 'retain', dataType: 'event-attendance-map', additional: undefined})
|
|
optional additional information about attendance at this event for each of the linked children |
| date |
Type : Date
|
Decorators :
@DatabaseField({label: undefined, dataType: 'date-only', defaultValue: undefined, anonymize: 'retain'})
|
| Static hasPII |
Type : unknown
|
Default value : true
|
|
Inherited from
Entity
|
| Static icon |
Type : IconName
|
Default value : "file-alt"
|
|
Inherited from
Entity
|
| Static label |
Type : unknown
|
Default value : $localize`:label for entity:Note`
|
|
Inherited from
Entity
|
| Static labelPlural |
Type : unknown
|
Default value : $localize`:label (plural) for entity:Notes`
|
| relatesTo |
Type : string
|
Decorators :
@DatabaseField({anonymize: 'retain'})
|
|
id referencing a different entity (e.g. a recurring activity) this note is related to |
| subject |
Type : string
|
Decorators :
@DatabaseField({label: undefined})
|
| text |
Type : string
|
Decorators :
@DatabaseField({label: undefined, dataType: 'long-text'})
|
| Static toStringAttributes |
Type : []
|
Default value : ["subject"]
|
|
Inherited from
Entity
|
| warningLevel |
Type : Ordering.EnumValue
|
Decorators :
@DatabaseField({label: undefined, dataType: 'configurable-enum', additional: 'warning-levels', anonymize: 'retain'})
|
| Static Optional _isCustomizedType |
| todo: This property is no longer used and will be removed in future versions. |
Type : boolean
|
|
Inherited from
Entity
|
|
True if this type's schema has been customized dynamically from the config. |
| _rev |
Type : string
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
|
internal database doc revision, used to detect conflicts by PouchDB/CouchDB |
| anonymized |
Type : boolean
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
|
Whether this entity has been anonymized and therefore cannot be re-activated. |
| Static color |
Type : string | ColorMapping[]
|
|
Inherited from
Entity
|
|
color used for to highlight this entity type across the app. Can be either:
|
| created |
Type : UpdateMetadata
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static DATABASE |
Type : string
|
Default value : "app"
|
|
Inherited from
Entity
|
|
The database where these entities are stored. |
| Static Optional enableUserAccounts |
Type : boolean
|
|
Inherited from
Entity
|
|
Whether to enable user account creation for this entity type. When true, the UI will allow management of user accounts associated with this entity. |
| Static ENTITY_TYPE |
Type : string
|
Default value : "Entity"
|
|
Inherited from
Entity
|
|
The entity's type.
In classes extending Entity this is usually overridden by the class annotation |
| inactive |
Type : boolean
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static Optional isInternalEntity |
Type : boolean
|
|
Inherited from
Entity
|
|
if this entity type is an internal entity, i.e. only defined in the code base to store internal system data and not visible to the user for customization. |
| Static schema |
Type : EntitySchema
|
|
Inherited from
Entity
|
|
EntitySchema defining property transformations from/to the database.
This is auto-generated from the property annotations see /additional-documentation/how-to-guides/create-a-new-entity-type.html |
| Static Optional toBlockDetailsAttributes |
Type : EntityBlockConfig
|
|
Inherited from
Entity
|
|
Defining which attributes will be displayed in a tooltip on hover when the record is displayed as an entity-block. |
| updated |
Type : UpdateMetadata
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static create | ||||||||||||||||
create(date: Date, subject: string, children: string[])
|
||||||||||||||||
|
Parameters :
Returns :
Note
|
| Public getColor |
getColor()
|
|
Inherited from
Entity
|
|
Returns :
any
|
| Public getColorForId | ||||||
|
Attendance logic will be decoupled from Note and only use the new |
||||||
getColorForId(childId: string)
|
||||||
|
Special color override to reflect the attendance status for a specific participant.
Parameters :
Returns :
string
|
| Static getPropertyFor | ||||||
|
special logic for Note will be removed. Default structure will only use a combined |
||||||
getPropertyFor(entityType: string)
|
||||||
|
Returns the name of the Note property where entities of the given entity type are stored
Parameters :
Returns :
"children" | "schools" | "authors" | "relatedEntities"
|
| getWarningLevel |
getWarningLevel()
|
|
Inherited from
Entity
|
|
Returns :
WarningLevel
|
| assertValid |
assertValid()
|
|
Inherited from
Entity
|
|
Checks if the entity is valid and if the check fails, throws an error explaining the failed check.
Returns :
void
|
| Public copy | ||||||||||
copy(newId: string | boolean)
|
||||||||||
|
Inherited from
Entity
|
||||||||||
|
Deep copy of the entity. The resulting entity will be of the same type as this (taking into account subclassing). All schema field values that are objects or arrays are deep-cloned to avoid shared mutable state between original and copy.
Parameters :
Returns :
unknown
|
| Static createPrefixedId | ||||||||||||
createPrefixedId(type: string, id: string)
|
||||||||||||
|
Inherited from
Entity
|
||||||||||||
|
Create a prefixed id by adding the type prefix if it isn't already part of the given id.
Parameters :
Returns :
string
|
| Static extractEntityIdFromId | ||||||||
extractEntityIdFromId(id: string)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Extract entityId without prefix.
Parameters :
Returns :
string
|
| Static extractTypeFromId | ||||||||
extractTypeFromId(id: string)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Extract the ENTITY_TYPE from an id.
Parameters :
Returns :
string
|
| Static getColorWithConditions | ||||||
getColorWithConditions(entity: Entity)
|
||||||
|
Inherited from
Entity
|
||||||
|
Static method to evaluate conditional colors for an entity based on ColorMapping configuration.
Parameters :
Returns :
string
|
| getConstructor |
getConstructor()
|
|
Inherited from
Entity
|
|
Get the class (Entity or the actual subclass of the instance) to call static methods on the correct class considering inheritance
Returns :
EntityConstructor<unknown>
|
| Public getId | ||||||||
getId(withoutPrefix: unknown)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Returns the id of this entity. Note that an id is final and can't be changed after the object has been instantiated, hence there is no
Parameters :
Returns :
string
the unique id of this entity |
| getSchema |
getSchema()
|
|
Inherited from
Entity
|
|
Get the entity schema of this class
Returns :
EntitySchema
|
| Public getType |
getType()
|
|
Inherited from
Entity
|
|
Returns the type which is used to categorize this entity in the database. Important: Do not overwrite this method! Types are handled internally.
Returns :
string
the entity's type (which is the class name). |
import { DatabaseEntity } from "../../../core/entity/database-entity.decorator";
import { Entity } from "../../../core/entity/model/entity";
import { DatabaseField } from "../../../core/entity/database-field.decorator";
import {
INTERACTION_TYPE_CONFIG_ID,
InteractionType,
} from "./interaction-type.interface";
import { AttendanceItem } from "#src/app/features/attendance/model/attendance-item";
import { AttendanceLogicalStatus } from "#src/app/features/attendance/model/attendance-status";
import { getWarningLevelColor, WarningLevel } from "../../warning-level";
import { Ordering } from "../../../core/basic-datatypes/configurable-enum/configurable-enum-ordering";
import { PLACEHOLDERS } from "../../../core/entity/schema/entity-schema-field";
import { IconName } from "@fortawesome/fontawesome-svg-core";
/**
* Notes are a special in-built entity type to record free-form information related to other records.
*
* Previously, `Note` has also functioned to record an event with an attendance list of participants.
* That functionality is getting generalized and decoupled from this specific entity.
* Add a "attendance" type field to any entity type instead.
* Attendance-related fields and methods here are currently kept (deprecated) for backwards compatibility until all existing data is migrated.
*/
@DatabaseEntity("Note")
export class Note extends Entity {
static override toStringAttributes = ["subject"];
static override label = $localize`:label for entity:Note`;
static override labelPlural = $localize`:label (plural) for entity:Notes`;
static override icon: IconName = "file-alt";
static override hasPII = true;
static create(
date: Date,
subject: string = "",
children: string[] = [],
): Note {
const instance = new Note();
instance.date = date;
instance.subject = subject;
instance.children = [...children];
return instance;
}
/**
* Returns the name of the Note property where entities of the given entity type are stored
* @param entityType
*
* @deprecated special logic for Note will be removed. Default structure will only use a combined `relatedEntities` field
*/
static getPropertyFor(entityType: string) {
switch (entityType) {
case "Child":
return "children";
case "School":
return "schools";
case "User":
return "authors";
default:
return "relatedEntities";
}
}
// TODO: remove these special properties (children, schools) and use relatedEntities instead once the attendance system is generalized (#1364)
/**
* IDs of Child entities linked with this note
*
* @deprecated Default structure will only use a combined `relatedEntities` field
*/
@DatabaseField({
label: $localize`:Label for the participants field of a note:Participants`,
dataType: "entity",
isArray: true,
additional: "Child",
entityReferenceRole: "composite",
editComponent: "EditLegacyAttendance",
anonymize: "retain",
})
children: string[] = [];
/**
* optional additional information about attendance at this event for each of the linked children
*
* @deprecated Attendance logic will be decoupled from Note. By default, notes will not include attendance details anymore. Any entity type can add an `attendance` type field.
*/
@DatabaseField({
anonymize: "retain",
dataType: "event-attendance-map",
additional: {
participant: {
dataType: "entity",
additional: ["Child"],
},
},
})
childrenAttendance: AttendanceItem[] = [];
@DatabaseField({
label: $localize`:Label for the date of a note:Date`,
dataType: "date-only",
defaultValue: {
mode: "dynamic",
config: { value: PLACEHOLDERS.NOW },
},
anonymize: "retain",
})
date: Date;
@DatabaseField({
label: $localize`:Label for the subject of a note:Subject`,
})
subject: string;
@DatabaseField({
label: $localize`:Label for the actual notes of a note:Notes`,
dataType: "long-text",
})
text: string;
/** IDs of users that authored this note */
@DatabaseField({
label: $localize`:Label for the social worker(s) who created the note:Team involved`,
dataType: "entity",
isArray: true,
additional: "User",
defaultValue: {
mode: "dynamic",
config: { value: PLACEHOLDERS.CURRENT_USER },
},
anonymize: "retain",
})
authors: string[] = [];
@DatabaseField({
label: $localize`:Label for the category of a note:Category`,
dataType: "configurable-enum",
additional: INTERACTION_TYPE_CONFIG_ID,
anonymize: "retain",
})
category: InteractionType;
@DatabaseField({
label: $localize`Attachment`,
dataType: "file",
})
attachment: string;
/**
* id referencing a different entity (e.g. a recurring activity) this note is related to
*/
@DatabaseField({
anonymize: "retain",
})
relatesTo: string;
/**
* other records (e.g. a recurring activity, group membership, ...) to which this note is related in some way,
* so that notes can be displayed linked to these entities.
*
* This property saves ids including their entity type prefix.
*/
@DatabaseField({
dataType: "entity",
isArray: true,
// by default no additional relatedEntities can be linked apart from children and schools, overwrite this in config to display (e.g. additional: "ChildSchoolRelation")
additional: undefined,
anonymize: "retain",
})
relatedEntities: string[] = [];
/**
* related school ids (e.g. to infer participants for event roll calls)
*
* @deprecated Default structure will only use a combined `relatedEntities` field
*/
@DatabaseField({
label: $localize`:label for the linked schools:Groups`,
dataType: "entity",
isArray: true,
additional: "School",
entityReferenceRole: "composite",
anonymize: "retain",
})
schools: string[] = [];
@DatabaseField({
label: $localize`:Status of a note:Status`,
dataType: "configurable-enum",
additional: "warning-levels",
anonymize: "retain",
})
warningLevel: Ordering.EnumValue;
override getWarningLevel(): WarningLevel {
if (this.warningLevel) {
return WarningLevel[this.warningLevel.id];
} else {
return WarningLevel.NONE;
}
}
public override getColor() {
const actualLevel = this.getWarningLevel();
if (actualLevel === WarningLevel.OK || actualLevel === WarningLevel.NONE) {
return this.category?.color;
} else {
return super.getColor();
}
}
/**
* Special color override to reflect the attendance status for a specific participant.
*
* @deprecated Attendance logic will be decoupled from Note and only use the new `attendance` datatype
*/
public getColorForId(childId: string): string {
if (
this.category?.isMeeting &&
this.childrenAttendance.find((item) => item.participant === childId)
?.status.countAs === AttendanceLogicalStatus.ABSENT
) {
// child is absent, highlight the entry
return getWarningLevelColor(WarningLevel.URGENT);
}
return this.getColor();
}
}