Class BaseRestrictionAbstract

constructor

• new BaseRestriction(
      __namedParameters?: BaseRestrictionAttributes,
  ): BaseRestriction

  Parameters

  • __namedParameters: BaseRestrictionAttributes = {}

  Returns BaseRestriction

Readonlyid

_allTimeFramesBefore

• _allTimeFramesBefore(date: MomentInput): boolean

  Parameters

  • date: MomentInput

  Returns boolean

_driveProfilesEquals

• _driveProfilesEquals(driveProfiles: DriveProfiles): boolean

  Parameters

  • driveProfiles: DriveProfiles

  Returns boolean

_hasDateRestrictedTimeFrames

• _hasDateRestrictedTimeFrames(): boolean

  Returns boolean

_timeFramesEquals

• _timeFramesEquals(timeFrames: RestrictionTimeFrame[]): boolean

  Parameters

  • timeFrames: RestrictionTimeFrame[]

  Returns boolean

equals

• equals(restriction: BaseRestriction): boolean

  Parameters

  • restriction: BaseRestriction

  Returns boolean

getDefaultType

• getDefaultType(): null | RESTRICTION_TYPE

  Returns null | RESTRICTION_TYPE

getDescription

• getDescription(): string

  Returns string

getDriveProfileList

• getDriveProfileList(
      restrictionType: RESTRICTION_TYPE,
  ): RestrictionDriveProfileList

  Parameters

  • restrictionType: RESTRICTION_TYPE

  Returns RestrictionDriveProfileList

getDrivingModality

• getDrivingModality(): | null
  | "DRIVING_ALLOWED"
  | "DRIVING_BLOCKED"
  | "DRIVING_TOLL_FREE"

  Return the modality of the restriction based on it's defaultType and drivingProfiles as listed below;

  +-------------------+-------------+------------------+-------------------------------------------+ | Modality | defaultType | driveProfileType | Semantics | +-------------------+-------------+------------------+-------------------------------------------+ | DRIVING_BLOCKED | FREE | BLOCKED | Some vehicles are blocked, others allowed | | DRIVING_BLOCKED | BLOCKED | N/A | All vehicles are blocked | | DRIVING_ALLOWED | BLOCKED | FREE | Some vehicles are allowed, others blocked | | DRIVING_TOLL_FREE | TOLL | FREE | Some vehicles don't pay, others pay | +-------------------+-------------+------------------+-------------------------------------------+

  Returns null | "DRIVING_ALLOWED" | "DRIVING_BLOCKED" | "DRIVING_TOLL_FREE"

  The modality

getTimeFrame

• getTimeFrame(): RestrictionTimeFrame

  Returns RestrictionTimeFrame

hasDriveProfile

• hasDriveProfile(restrictionType: RESTRICTION_TYPE): boolean

  Parameters

  • restrictionType: RESTRICTION_TYPE

  Returns boolean

isAllowedModality

• isAllowedModality(): boolean

  Returns boolean

isBlockedModality

• isBlockedModality(): boolean

  Returns boolean

isDifficult

• isDifficult(): boolean

  Returns boolean

isDifficult24Seven

• isDifficult24Seven(): boolean

  Returns boolean

isDriveProfileEmpty

• isDriveProfileEmpty(): boolean

  Returns boolean

isEditable

• isEditable(): boolean

  Returns boolean

isExpired

• isExpired(): boolean

  Returns boolean

isNot24Seven

• isNot24Seven(): boolean

  Returns boolean

isRepeatsYearly

• isRepeatsYearly(): boolean

  Returns boolean

isTollFreeModality

• isTollFreeModality(): boolean

  Returns boolean

supportsDaysOfMonthParity

• supportsDaysOfMonthParity(): boolean

  Returns boolean

supportsDriveProfiles

• supportsDriveProfiles(): boolean

  Returns boolean

supportsLicensePlateNumber

• supportsLicensePlateNumber(): boolean

  Returns boolean

supportsNumPassengers

• supportsNumPassengers(): boolean

  Returns boolean

supportsSubscriptions

• supportsSubscriptions(): boolean

  Returns boolean

supportsTollDriveProfileEntries

• supportsTollDriveProfileEntries(): boolean

  Returns boolean

toJSON

• toJSON(): {
      defaultType: null
      | RESTRICTION_TYPE;
      description: undefined | null | string;
      driveProfiles: { [key: string]: DriveProfileAttributes[] };
      editable: boolean;
      timeFrames: {
          daysOfMonth: null | DAYS_OF_MONTH;
          endDate: null | string;
          fromTime: null | string;
          repeatYearly: null | boolean;
          startDate: null | string;
          timeZone: null | string;
          toTime: null | string;
          weekdays: null | number;
      }[];
  }

  Returns {
      defaultType: null | RESTRICTION_TYPE;
      description: undefined | null | string;
      driveProfiles: { [key: string]: DriveProfileAttributes[] };
      editable: boolean;
      timeFrames: {
          daysOfMonth: null | DAYS_OF_MONTH;
          endDate: null | string;
          fromTime: null | string;
          repeatYearly: null | boolean;
          startDate: null | string;
          timeZone: null | string;
          toTime: null | string;
          weekdays: null | number;
      }[];
  }

Abstractwith

• with(attributes: BaseRestrictionAttributes): BaseRestriction

  Parameters

  • attributes: BaseRestrictionAttributes

  Returns BaseRestriction