@defra-fish/dynamics-lib/src/entities/permission.entity.js

Framework to support integration with dynamics

import { BaseEntity, EntityDefinition } from './base.entity.js'
import { Contact } from './contact.entity.js'
import { Permit } from './permit.entity.js'
import { ConcessionProof } from './concession-proof.entity.js'
import { PoclFile } from './pocl-file.entity.js'
import { Transaction } from './transaction.entity.js'

/**
 * Permission entity
 * @extends BaseEntity
 */
export class Permission extends BaseEntity {
  /** @type {EntityDefinition} */
  static _definition = new EntityDefinition(() => ({
    localName: 'permission',
    dynamicsCollection: 'defra_permissions',
    defaultFilter: 'statecode eq 0',
    mappings: {
      id: { field: 'defra_permissionid', type: 'string' },
      referenceNumber: { field: 'defra_name', type: 'string' },
      issueDate: { field: 'defra_issuedate', type: 'datetime' },
      startDate: { field: 'defra_startdate', type: 'datetime' },
      endDate: { field: 'defra_enddate', type: 'datetime' },
      stagingId: { field: 'defra_stagingid', type: 'string' },
      dataSource: { field: 'defra_datasource', type: 'optionset', ref: 'defra_datasource' },
      isRenewal: { field: 'defra_renewal', type: 'boolean' },
      isRecurringPayment: { field: 'defra_rcpagreement', type: 'boolean' },
      isLicenceForYou: { field: 'defra_licenceforyou', type: 'optionset', ref: 'defra_islicenceforyou' }
    },
    relationships: {
      licensee: { property: 'defra_ContactId', entity: Contact, parent: true },
      permit: { property: 'defra_PermitId', entity: Permit, parent: true },
      transaction: { property: 'defra_Transaction', entity: Transaction, parent: true },
      poclFile: { property: 'defra_POCLFileId', entity: PoclFile, parent: true },
      concessionProofs: { property: 'defra_defra_permission_defra_concessionproof_PermissionId', entity: ConcessionProof }
    }
  }))

  /**
   * The {@link EntityDefinition} providing mappings between Dynamics entity and the local entity
   * @type {EntityDefinition}
   */
  static get definition () {
    return Permission._definition
  }

  /**
   * The reference number associated with the permission
   * @type {string}
   */
  get referenceNumber () {
    return super._getState('referenceNumber')
  }

  set referenceNumber (referenceNumber) {
    super._setState('referenceNumber', referenceNumber)
  }

  /**
   * The issue date associated with the permission
   * @type {string|Date}
   */
  get issueDate () {
    return super._getState('issueDate')
  }

  set issueDate (issueDate) {
    super._setState('issueDate', issueDate)
  }

  /**
   * The start date associated with the permission
   * @type {string|Date}
   */
  get startDate () {
    return super._getState('startDate')
  }

  set startDate (startDate) {
    super._setState('startDate', startDate)
  }

  /**
   * The end date associated with the permission
   * @type {string|Date}
   */
  get endDate () {
    return super._getState('endDate')
  }

  set endDate (endDate) {
    super._setState('endDate', endDate)
  }

  /**
   * The data source associated with the permission
   * @type {Object<GlobalOptionSetDefinition>}
   */
  get dataSource () {
    return super._getState('dataSource')
  }

  set dataSource (dataSource) {
    super._setState('dataSource', dataSource)
  }

  /**
   * The staging identifier associated with the permission
   * @type {string}
   */
  get stagingId () {
    return super._getState('stagingId')
  }

  set stagingId (stagingId) {
    super._setState('stagingId', stagingId)
  }

  /**
   * Whether the permission is a renewal
   * @type {boolean}
   */
  get isRenewal () {
    return super._getState('isRenewal')
  }

  set isRenewal (isRenewal) {
    super._setState('isRenewal', isRenewal)
  }

  /**
   * Whether the permission has a recurring payment agreement
   * @type {boolean}
   */
  get isRecurringPayment () {
    return super._getState('isRecurringPayment')
  }

  set isRecurringPayment (isRecurringPayment) {
    super._setState('isRecurringPayment', isRecurringPayment)
  }

  /*
   * Whether the permission is for the user purchasing the licence or someone else
   * @type {boolean}
   */
  get isLicenceForYou () {
    return super._getState('isLicenceForYou')
  }

  set isLicenceForYou (isLicenceForYou) {
    super._setState('isLicenceForYou', isLicenceForYou)
  }
}