Interface IRecordsManagementProperties

The records management properties of an entry. This is the abstract base; the concrete shape is RecordProperties for a document record (RecordType = Record) or RecordFolderProperties for a record folder (RecordFolder). Members common to both record and record folder live here; type-specific members live on the subtypes. Many members are computed by the repository and are read-only — they are noted as such and are ignored on update.

interface IRecordsManagementProperties {
    activeDispositionScheduleId?: number;
    cutoffCriterionId?: number;
    cutoffDate?: Date;
    cutoffEligibility?: Date;
    dispositionConfirmationDate?: Date;
    dispositionScheduleId?: number;
    dispositionState?: LfRepositoryClientV2.DispositionState;
    filingDate?: Date;
    finalDispositionEligibility?: Date;
    isCutoff?: boolean;
    isEligibleForCutoff?: boolean;
    isEligibleForFinalDisposition?: boolean;
    locationId?: number;
    recordType?: LfRepositoryClientV2.RecordEntryType;
    transferDates?: LfRepositoryClientV2.RecordsManagementTransferDate[];
    triggerDate?: Date;
}

Hierarchy (View Summary)

Implemented by

Properties

activeDispositionScheduleId? cutoffCriterionId? cutoffDate? cutoffEligibility? dispositionConfirmationDate? dispositionScheduleId? dispositionState? filingDate? finalDispositionEligibility? isCutoff? isEligibleForCutoff? isEligibleForFinalDisposition? locationId? recordType? 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).

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

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

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.

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