ndb-core documentation
  1. Classes
  2. TimePeriod
src/app/core/entity-details/related-time-period-entities/time-period.ts

Description

Record that is only active for a given time period.

Extends

Entity

Relationships

Used by

Depends on

Index

Properties
Methods
Accessors

Properties

end
Type : Date
Decorators :
@DatabaseField({dataType: 'date-only', label: undefined, description: undefined})
Defined in src/app/core/entity-details/related-time-period-entities/time-period.ts:23
start
Type : Date
Decorators :
@DatabaseField({dataType: 'date-only', label: undefined, description: undefined})
Defined in src/app/core/entity-details/related-time-period-entities/time-period.ts:16
Static Optional _isCustomizedType
todo: This property is no longer used and will be removed in future versions.
Type : boolean
Inherited from Entity
Entity:93

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
Entity:248

internal database doc revision, used to detect conflicts by PouchDB/CouchDB
anonymized
Type : boolean
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
Inherited from Entity
Entity:269

Whether this entity has been anonymized and therefore cannot be re-activated.
Static color
Type : string | ColorMapping[]
Inherited from Entity
Entity:160

color used for to highlight this entity type across the app.

Can be either:

  • A simple string (hex color code) for a single color
  • An array of ColorMapping objects for conditional colors based on entity properties
created
Type : UpdateMetadata
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
Inherited from Entity
Entity:254
Static DATABASE
Type : string
Default value : "app"
Inherited from Entity
Entity:79

The database where these entities are stored.
Static Optional enableUserAccounts
Type : boolean
Inherited from Entity
Entity:124

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
Entity:74

The entity's type. In classes extending Entity this is usually overridden by the class annotation @DatabaseEntity('NewEntity'). The type needs to be used as routing path in lower case. The routing path can be defined in the configuration file.
Static hasPII
Type : boolean
Default value : false
Inherited from Entity
Entity:233

whether this entity type can contain "personally identifiable information" (PII) and therefore should follow strict data protection requirements and offer a function to anonymize records.
Static icon
Type : IconName
Inherited from Entity
Entity:151

icon id used for this entity
inactive
Type : boolean
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
Inherited from Entity
Entity:263
Static Optional isInternalEntity
Type : boolean
Inherited from Entity
Entity:118

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 label
Type : string
Inherited from Entity
Entity:111

human-readable name/label of the entity in the UI
Static schema
Type : EntitySchema
Inherited from Entity
Entity:87

EntitySchema defining property transformations from/to the database. This is auto-generated from the property annotations @DatabaseField().

see /additional-documentation/how-to-guides/create-a-new-entity-type.html
Static Optional toBlockDetailsAttributes
Type : EntityBlockConfig
Inherited from Entity
Entity:106

Defining which attributes will be displayed in a tooltip on hover when the record is displayed as an entity-block.
Static toStringAttributes
Type : []
Default value : ["entityId"]
Inherited from Entity
Entity:101

Defining which attribute values of an entity should be shown in the .toString() method.

The default is the ID of the entity (entityId). This can be overwritten in subclasses or through the config.
updated
Type : UpdateMetadata
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
Inherited from Entity
Entity:260

Methods

assertValid
assertValid()
Inherited from Entity
Entity:52
Returns : void
getColor
getColor()
Inherited from Entity
Entity:48
Returns : string
isActiveAt
isActiveAt(date: Date)
Defined in src/app/core/entity-details/related-time-period-entities/time-period.ts:41

Checks whether this relation was active on a specific date

Parameters :
Name Type Optional Description
date Date No

on which the active status should be checked
Returns : boolean
Public copy
copy(newId: string | boolean)
Inherited from Entity
Entity:476

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 :
Name Type Optional Default value Description
newId string | boolean No false

if true, a new entityId will be generated; if a string, that value is used as new entityId
Returns : unknown
Static createPrefixedId
createPrefixedId(type: string, id: string)
Inherited from Entity
Entity:218

Create a prefixed id by adding the type prefix if it isn't already part of the given id.

Parameters :
Name Type Optional Description
type string No

The type prefix to be added.
id string No

The id to be extended with a prefix.
Returns : string
Static extractEntityIdFromId
extractEntityIdFromId(id: string)
Inherited from Entity
Entity:197

Extract entityId without prefix.

Parameters :
Name Type Optional Description
id string No

An entity's id including prefix.
Returns : string
Static extractTypeFromId
extractTypeFromId(id: string)
Inherited from Entity
Entity:183

Extract the ENTITY_TYPE from an id.

Parameters :
Name Type Optional Description
id string No

An entity's id including prefix.
Returns : string
Static getColorWithConditions
getColorWithConditions(entity: Entity)
Inherited from Entity
Entity:407

Static method to evaluate conditional colors for an entity based on ColorMapping configuration.

Parameters :
Name Type Optional
entity Entity No
Returns : string
getConstructor
getConstructor()
Inherited from Entity
Entity:330

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
Entity:349

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 setId() method.

Parameters :
Name Type Optional Default value
withoutPrefix unknown No false
Returns : string

the unique id of this entity
getSchema
getSchema()
Inherited from Entity
Entity:337

Get the entity schema of this class

Returns : EntitySchema
Public getType
getType()
Inherited from Entity
Entity:360

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).
Public getWarningLevel
getWarningLevel()
Inherited from Entity
Entity:463

Override getWarningLevel() to define when the entity is in a critical condition and should be color-coded and highlighted in generic components of the UI.

Returns : WarningLevel

Accessors

isActive
getisActive()
Defined in src/app/core/entity-details/related-time-period-entities/time-period.ts:28

Returns true if this relation is currently active

Returns : boolean 
import { Entity } from "../../entity/model/entity";
import { DatabaseEntity } from "../../entity/database-entity.decorator";
import { DatabaseField } from "../../entity/database-field.decorator";
import moment from "moment";

/**
 * Record that is only active for a given time period.
 */
@DatabaseEntity("TimePeriod")
export class TimePeriod extends Entity {
  @DatabaseField({
    dataType: "date-only",
    label: $localize`:Label for the start date of a relation:Start date`,
    description: $localize`:Description of the start date of a relation:The date from when this is active.`,
  })
  start: Date;

  @DatabaseField({
    dataType: "date-only",
    label: $localize`:Label for the end date of a relation:End date`,
    description: $localize`:Description of the end date of a relation:The date after which this is inactive.`,
  })
  end: Date;

  /**
   * Returns true if this relation is currently active
   */
  override get isActive(): boolean {
    if (this.inactive) {
      // manual archiving of records takes precendence
      return false;
    }

    return this.isActiveAt(new Date());
  }

  /**
   * Checks whether this relation was active on a specific date
   * @param date on which the active status should be checked
   */
  isActiveAt(date: Date): boolean {
    return (
      (!this.start || moment(this.start).isSameOrBefore(date, "day")) &&
      (!this.end || moment(this.end).isSameOrAfter(date, "day"))
    );
  }

  override getColor(): string {
    return this.isActive ? "#90ee9040" : "";
  }

  override assertValid() {
    super.assertValid();

    this.checkValidDateRange();
  }

  private checkValidDateRange() {
    if (!this.end) {
      // without end date, any range is valid
      return;
    }

    const startLabel = this.getSchema().get("start").label;
    const endLabel = this.getSchema().get("end").label;
    if (this.end && !this.start) {
      throw new Error(
        $localize`:Error assertValid failed:No "${startLabel}" date is set`,
      );
    } else if (moment(this.start).isAfter(this.end, "days")) {
      throw new Error(
        $localize`:Error assertValid failed:The "${startLabel}" date is after the "${endLabel}" date`,
      );
    }
  }
}

results matching ""

    No results matching ""