Interface IRecordProperties

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

interface IRecordProperties {
    activeDispositionScheduleId?: number;
    cutoffCriterionId?: number;
    cutoffDate?: Date;
    cutoffEligibility?: Date;
    dispositionConfirmationDate?: Date;
    dispositionScheduleId?: number;
    dispositionState?: DispositionState;
    filingDate?: Date;
    finalDispositionEligibility?: Date;
    isCutoff?: boolean;
    isCutoffCriterionInherited?: boolean;
    isDispositionScheduleInherited?: boolean;
    isEligibleForCutoff?: boolean;
    isEligibleForFinalDisposition?: boolean;
    isIndividuallyCutoff?: boolean;
    lastReviewDate?: Date;
    locationId?: number;
    nextReviewDate?: Date;
    recordFolderId?: number;
    recordType?: RecordEntryType;
    reviewer?: string;
    transferDates?: RecordsManagementTransferDate[];
    triggerDate?: Date;
    underRecordFolder?: boolean;
}

Hierarchy (View Summary)

Implemented by

Properties

activeDispositionScheduleId? cutoffCriterionId? cutoffDate? cutoffEligibility? dispositionConfirmationDate? dispositionScheduleId? dispositionState? filingDate? finalDispositionEligibility? isCutoff? isCutoffCriterionInherited? isDispositionScheduleInherited? isEligibleForCutoff? isEligibleForFinalDisposition? isIndividuallyCutoff? lastReviewDate? locationId? nextReviewDate? recordFolderId? recordType? reviewer? transferDates? triggerDate? underRecordFolder?

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).

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?: 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).

OptionalisCutoff

isCutoff?: boolean

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

OptionalisCutoffCriterionInherited

isCutoffCriterionInherited?: boolean

True when the cutoff criterion is inherited from the record folder.

OptionalisDispositionScheduleInherited

isDispositionScheduleInherited?: boolean

True when the disposition schedule is inherited from the record folder.

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).

OptionalisIndividuallyCutoff

isIndividuallyCutoff?: boolean

True when the record was cut off individually rather than with its folder. Computed (read-only).

OptionallastReviewDate

lastReviewDate?: Date

The last vital-record review date, or null when unset.

OptionallocationId

locationId?: number

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

OptionalnextReviewDate

nextReviewDate?: Date

The next scheduled vital-record review date, or null. Computed (read-only).

OptionalrecordFolderId

recordFolderId?: number

The record folder this record is filed under, or null when independent. Computed (read-only).

OptionalrecordType

recordType?: 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.

Optionalreviewer

reviewer?: string

The reviewer recorded for the last vital-record review, or null. Computed (read-only).

OptionaltransferDates

transferDates?: RecordsManagementTransferDate[]

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

OptionaltriggerDate

triggerDate?: Date

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

OptionalunderRecordFolder

underRecordFolder?: boolean

True when the record is filed under a record folder. Computed (read-only).

Settings

Member Visibility

On This Page

Properties