Interface IRecordSeriesProperties

A record series' retention defaults. A record series provides cascading defaults (cutoff criterion, disposition schedule, review cycle, permanence, disposition authority) that the record folders and records beneath it resolve against.

interface IRecordSeriesProperties {
    code?: string;
    cutoffCriterionId?: number;
    dispositionAuthority?: string;
    dispositionScheduleId?: number;
    isPermanent?: boolean;
    reviewCycleId?: number;
    reviewInterval?: number;
    reviewIntervalUnit?: ReviewIntervalUnit;
}

Implemented by

Properties

code? cutoffCriterionId? dispositionAuthority? dispositionScheduleId? isPermanent? reviewCycleId? reviewInterval? reviewIntervalUnit?

Properties

Optionalcode

code?: string

The record series code.

OptionalcutoffCriterionId

cutoffCriterionId?: number

The default cutoff criterion id, or null when none.

OptionaldispositionAuthority

dispositionAuthority?: string

The disposition authority name, or null.

OptionaldispositionScheduleId

dispositionScheduleId?: number

The default disposition schedule id, or null when none.

OptionalisPermanent

isPermanent?: boolean

True when records under the series are permanent (never destroyed).

OptionalreviewCycleId

reviewCycleId?: number

The default vital-record review cycle (calendar cycle) id, or null when none.

OptionalreviewInterval

reviewInterval?: number

The default vital-record review interval, or null when none.

OptionalreviewIntervalUnit

reviewIntervalUnit?: ReviewIntervalUnit

The default review interval unit.

Settings

Member Visibility

On This Page

Properties