Interface IRecordFolderProperties

The records management properties of a record folder (RecordType = RecordFolder). Adds the record-folder-only members to the common RecordsManagementProperties shape.

interface IRecordFolderProperties {
    activeDispositionScheduleId?: number;
    cutoffCriterionId?: number;
    cutoffDate?: Date;
    cutoffEligibility?: Date;
    dispositionAuthority?: string;
    dispositionConfirmationDate?: Date;
    dispositionScheduleId?: number;
    dispositionState?: LfRepositoryClientV2.DispositionState;
    filingDate?: Date;
    finalDispositionEligibility?: Date;
    isClosed?: boolean;
    isCutoff?: boolean;
    isEligibleForCutoff?: boolean;
    isEligibleForFinalDisposition?: boolean;
    isPermanent?: boolean;
    locationId?: number;
    recordType?: LfRepositoryClientV2.RecordEntryType;
    reviewCycleId?: number;
    reviewInterval?: number;
    reviewIntervalUnit?: LfRepositoryClientV2.ReviewIntervalUnit;
    transferDates?: LfRepositoryClientV2.RecordsManagementTransferDate[];
    triggerDate?: Date;
}

Hierarchy (View Summary)

Implemented by

Properties

activeDispositionScheduleId? cutoffCriterionId? cutoffDate? cutoffEligibility? dispositionAuthority? dispositionConfirmationDate? dispositionScheduleId? dispositionState? filingDate? finalDispositionEligibility? isClosed? isCutoff? isEligibleForCutoff? isEligibleForFinalDisposition? isPermanent? locationId? recordType? reviewCycleId? reviewInterval? reviewIntervalUnit? transferDates? triggerDate?

Properties

OptionalactiveDispositionScheduleId

activeDispositionScheduleId?: number

The disposition schedule currently governing the entry (own or inherited), or null. Computed (read-only).

OptionalcutoffCriterionId

cutoffCriterionId?: number

The cutoff criterion assigned to the entry, or null when none.

OptionalcutoffDate

cutoffDate?: Date

The date the entry was cut off, or null if not cut off. Computed (read-only).

OptionalcutoffEligibility

cutoffEligibility?: Date

The date the entry becomes eligible for cutoff, or null. Computed (read-only).

OptionaldispositionAuthority

dispositionAuthority?: string

The disposition authority name, or null.

OptionaldispositionConfirmationDate

dispositionConfirmationDate?: Date

The date final disposition was confirmed, or null. Computed (read-only).

OptionaldispositionScheduleId

dispositionScheduleId?: number

The disposition schedule assigned to the entry, or null when none.

OptionaldispositionState

dispositionState?: LfRepositoryClientV2.DispositionState

The current lifecycle state. Computed (read-only).

OptionalfilingDate

filingDate?: Date

The filing date, or null when unset.

OptionalfinalDispositionEligibility

finalDispositionEligibility?: Date

The date the entry becomes eligible for final disposition, or null. Computed (read-only).

OptionalisClosed

isClosed?: boolean

True when the record folder is closed to new filings.

OptionalisCutoff

isCutoff?: boolean

True when the entry has been cut off. Computed (read-only).

OptionalisEligibleForCutoff

isEligibleForCutoff?: boolean

True when the entry is currently eligible for cutoff. Computed (read-only).

OptionalisEligibleForFinalDisposition

isEligibleForFinalDisposition?: boolean

True when the entry is currently eligible for final disposition. Computed (read-only).

OptionalisPermanent

isPermanent?: boolean

True when the record folder is permanent (never destroyed).

OptionallocationId

locationId?: number

The records management location the entry currently resides at, or null. Computed (read-only).

OptionalrecordType

recordType?: LfRepositoryClientV2.RecordEntryType

Whether these properties describe a document record or a record folder. Determines the concrete subtype (RecordProperties or RecordFolderProperties) and which type-specific members are present.

OptionalreviewCycleId

reviewCycleId?: number

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

OptionalreviewInterval

reviewInterval?: number

The vital-record review interval, or null.

OptionalreviewIntervalUnit

reviewIntervalUnit?: LfRepositoryClientV2.ReviewIntervalUnit

The review interval unit.

OptionaltransferDates

transferDates?: LfRepositoryClientV2.RecordsManagementTransferDate[]

Projected and completed interim transfers. Computed (read-only).

OptionaltriggerDate

triggerDate?: Date

The alternate-retention trigger date, or null when unset.

Settings

Member Visibility

On This Page

Properties