Skip to content

Template

Template is a data-carrier contract (DTO) in the Documents area of SAIF.SAIFCode.Core, exposing the properties SAIF.Services and its consumers read and populate for this entity*.

Purpose

  • Carries data for the Documents area, consumed by SAIF.Services and other layers that reference this library's contracts*.

Context

  • Namespace: SAIF.Core.Contracts.Documents
  • Kind: Class
  • Assembly/package: SAIF.Core (NuGet package SAIF.SAIFCode.Core)

Public members

Member Signature Purpose
WordOutputProfileCode public const string WordOutputProfileCode = "WORD"; Named constant value ("WORD")*.
PDFtoFileOutputProfileCode public const string PDFtoFileOutputProfileCode = "PDFF"; Named constant value ("PDFF")*.
CCEnabledOptionCode public const string CCEnabledOptionCode = "CCYES"; Named constant value ("CCYES")*.
AllowCertifiedOptionCode public const string AllowCertifiedOptionCode = "CERT"; Named constant value ("CERT")*.
CertifiedRequiredOptionCode public const string CertifiedRequiredOptionCode = "CRTRQ"; Named constant value ("CRTRQ")*.
AllowReturnReceiptOptionCode public const string AllowReturnReceiptOptionCode = "REG"; Named constant value ("REG")*.
ReturnRecieptRequiredOptionCode public const string ReturnRecieptRequiredOptionCode = "REGRQ"; Named constant value ("REGRQ")*.
PrintToLocalPrinterOptionCode public const string PrintToLocalPrinterOptionCode = "PLOC"; Named constant value ("PLOC")*.
PrintNotAllowedForMROptionCode public const string PrintNotAllowedForMROptionCode = "PMNA"; Named constant value ("PMNA")*.
AllowEmailOptionCode public const string AllowEmailOptionCode = "EMAIL"; Named constant value ("EMAIL")*.
AllowFaxOptionCode public const string AllowFaxOptionCode = "FAX"; Named constant value ("FAX")*.
ImagingAlertOptionCode public const string ImagingAlertOptionCode = "ALERT"; Named constant value ("ALERT")*.
HideMRDeliveryMethodViewOptionCode public const string HideMRDeliveryMethodViewOptionCode = "HDMD"; Named constant value ("HDMD")*.
MainRecipientDocumentRecipientOptionCode public const string MainRecipientDocumentRecipientOptionCode = "MRDR"; Named constant value ("MRDR")*.
ProviderRecipientOptionCode public const string ProviderRecipientOptionCode = "PRAD"; Named constant value ("PRAD")*.
Id long Id { get; set; } Represents the ID associated with this Template*.
DocumentTemplateOpsList string DocumentTemplateOpsList { get; set; } Represents the document template ops list associated with this Template*.
DocumentTemplateOptionsList string DocumentTemplateOptionsList { get; set; } Represents the document template options list associated with this Template*.
Name string Name { get; set; } Represents the name associated with this Template*.
Title string Title { get; set; } Represents the title associated with this Template*.
RunType string RunType { get; set; } Classifies the run type applicable to this Template*.
RunTypeDescription string RunTypeDescription { get; set; } Holds free-text description recorded against this Template*.
RunRoutine string RunRoutine { get; set; } Represents the run routine associated with this Template*.
RunTemplate string RunTemplate { get; set; } Represents the run template associated with this Template*.
RunParameterFormName string RunParameterFormName { get; set; } Holds the run parameter form name recorded on this Template*.
NextDocTemplateSeqNum long? NextDocTemplateSeqNum { get; set; } Represents the next doc template seq num associated with this Template*.
AdditionalPageNum long? AdditionalPageNum { get; set; } Represents the additional page num associated with this Template*.
ContextType string ContextType { get; set; } Classifies the context type applicable to this Template*.
ContextTypeDescription string ContextTypeDescription { get; set; } Holds free-text description recorded against this Template*.
BusinessGroup string BusinessGroup { get; set; } Represents the business group associated with this Template*.
Subgroup string Subgroup { get; set; } Represents the subgroup associated with this Template*.
IsEnabled bool IsEnabled { get; set; } Indicates whether this Template is a enabled*.
EffectiveDate DateTime? EffectiveDate { get; set; } Records the date of the effective*.
ExpirationDate DateTime? ExpirationDate { get; set; } Records the date of the expiration*.
NoteText string NoteText { get; set; } Holds free-text text recorded against this Template*.
ImageFileCode string ImageFileCode { get; set; } Classifies the image file using a coded value*.
ImageCategoryCode string ImageCategoryCode { get; set; } Classifies the image category using a coded value*.
ImageDocumentTypeCode string ImageDocumentTypeCode { get; set; } Classifies the image document type using a coded value*.
ImageDocumentNameCode string ImageDocumentNameCode { get; set; } Classifies the image document name using a coded value*.
ImageDocumentName string ImageDocumentName { get; set; } Holds the image document name recorded on this Template*.
ImageIsRequired bool ImageIsRequired { get; set; } Represents the image is required associated with this Template*.
OnBaseTypeGroupCode string OnBaseTypeGroupCode { get; set; } Classifies the on base type group using a coded value*.
OnBaseTypeCode string OnBaseTypeCode { get; set; } Classifies the on base type using a coded value*.
OnBaseSubTypeCode string OnBaseSubTypeCode { get; set; } Classifies the on base sub type using a coded value*.
IsDiscoverableByDefault string IsDiscoverableByDefault { get; set; } Represents the is discoverable by default associated with this Template*.
DefaultExternalViewCode string DefaultExternalViewCode { get; set; } Classifies the default external view using a coded value*.
SharedMessage string SharedMessage { get; set; } Represents the shared message associated with this Template*.
MainBannerPageText string MainBannerPageText { get; set; } Holds free-text text recorded against this Template*.
AdditionalBannerPageText string AdditionalBannerPageText { get; set; } Holds free-text text recorded against this Template*.
UpdateNumber string UpdateNumber { get; set; } Uniquely identifies the update recorded on this Template*.
UpdateUser string UpdateUser { get; set; } Identifies the user tied to the update on this Template*.
UpdateDate DateTime? UpdateDate { get; set; } Records the date of the update*.
CreateUser string CreateUser { get; set; } Identifies the user tied to the create on this Template*.
CreateDate DateTime? CreateDate { set; } Records the date of the create*.

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

  • Core/SAIF.Core/Contracts/Documents/Template.cs