Class DocumentEntity

This class represents the EntityModel interface to the CmDocument database table.

Inheritance

System.Object

DocumentEntity

Implements

Cmc.Core.ComponentModel.IIdentifiable

Cmc.Core.ComponentModel.IAuditable

Namespace: Cmc.Nexus.Crm.Entities

Assembly: Cmc.Nexus.Crm.Contracts.dll

Syntax

public class DocumentEntity : Entity, IIdentifiable, IAuditable

Constructors

DocumentEntity()

Declaration

public DocumentEntity()

Fields

ApprovedDateProperty

The The date that the institution accepted the documents submitted by the student, or by persons and organizations connected with the student. property.

Declaration

public static readonly EntityProperty ApprovedDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

AwardYearProperty

The The financial aid award year which is the period beginning July 1 and ending June 30 of the following year. property.

Declaration

public static readonly EntityProperty AwardYearProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

CreatedByUserIdProperty

The The last and then first name of the staff member who added or created the item. property.

Declaration

public static readonly EntityProperty CreatedByUserIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

CreatedDateTimeProperty

The The date when the item or person was added or the status change was entered. property.

Declaration

public static readonly EntityProperty CreatedDateTimeProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentImageProperty

The The documents submitted by a student, or by persons and organizations connected with the student. property.

Declaration

public static readonly EntityProperty DocumentImageProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentScheduleIdProperty

The DocumentScheduleId property.

Declaration

public static readonly EntityProperty DocumentScheduleIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentStatusIdProperty

The The status of the document. The list contains the predefined statuses of Requested - Required, Requested - Not Required, Approved, No Further Action, Not Requested, Required, Received but Rejected, Sent, and Not Sent. Any additional items in the lists were defined by your organization. property.

Declaration

public static readonly EntityProperty DocumentStatusIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentTranscriptRequestIdProperty

The DocumentTranscriptRequestId property.

Declaration

public static readonly EntityProperty DocumentTranscriptRequestIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentTriggerIdProperty

The DocumentTriggerId property.

Declaration

public static readonly EntityProperty DocumentTriggerIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DocumentTypeIdProperty

The The type of document submitted to the institution. property.

Declaration

public static readonly EntityProperty DocumentTypeIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

DueDateProperty

The The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. property.

Declaration

public static readonly EntityProperty DueDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ExpiresDateProperty

The The date when the group or document is no longer valid. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. The default is calculated using the value for Default Number of Days to Retain Student Groups on the Options tab for the campus in the Desktop Client (Setup > Campus Location). property.

Declaration

public static readonly EntityProperty ExpiresDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IdProperty

The Id property.

Declaration

public static readonly EntityProperty IdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ImageNowDocId0Property

The ImageNowDocId0 property.

Declaration

public static readonly EntityProperty ImageNowDocId0Property

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ImageNowDocId1Property

The ImageNowDocId1 property.

Declaration

public static readonly EntityProperty ImageNowDocId1Property

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ImageTypeProperty

The ImageType property.

Declaration

public static readonly EntityProperty ImageTypeProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsDocumentAddedManuallyProperty

The IsDocumentAddedManually property.

Declaration

public static readonly EntityProperty IsDocumentAddedManuallyProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsPermitProperty

The IsPermit property.

Declaration

public static readonly EntityProperty IsPermitProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

LastModifiedDateTimeProperty

The The date that the item was updated or changed. property.

Declaration

public static readonly EntityProperty LastModifiedDateTimeProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

LastModifiedUserIdProperty

The The last and then first name of the person that changed the item. property.

Declaration

public static readonly EntityProperty LastModifiedUserIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ModuleIdProperty

The The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on. property.

Declaration

public static readonly EntityProperty ModuleIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

NoteProperty

The Area you can use to display or specify comments or additional information. property.

Declaration

public static readonly EntityProperty NoteProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

NotSentDocument

Declaration

public static readonly string NotSentDocument

Field Value

Type	Description
System.String

OriginalFileNameProperty

The OriginalFileName property.

Declaration

public static readonly EntityProperty OriginalFileNameProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ReceivedDateProperty

The The date the institution received the documents submitted by the student, or by persons and organizations connected with the student. property.

Declaration

public static readonly EntityProperty ReceivedDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

RequestedDateProperty

The The date when an institution, person, or a student requested documents or information to be submitted for evaluation. property.

Declaration

public static readonly EntityProperty RequestedDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

RowVersionProperty

The RowVersion property.

Declaration

public static readonly EntityProperty RowVersionProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ScannedProperty

The Scanned property.

Declaration

public static readonly EntityProperty ScannedProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

SentDateProperty

The The date when the requested information or document is sent. property.

Declaration

public static readonly EntityProperty SentDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

SentDocument

Declaration

public static readonly string SentDocument

Field Value

Type	Description
System.String

StudentCourseDocumentPermitsProperty

The StudentCourseDocumentPermits property.

Declaration

public static readonly EntityProperty StudentCourseDocumentPermitsProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

StudentEnrollmentPeriodIdProperty

The The code and name of the enrollment. property.

Declaration

public static readonly EntityProperty StudentEnrollmentPeriodIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

StudentIdProperty

The StudentId property.

Declaration

public static readonly EntityProperty StudentIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

StudentPlacementIdProperty

The StudentPlacementId property.

Declaration

public static readonly EntityProperty StudentPlacementIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

WorkflowInstanceIdentifierProperty

The WorkflowInstanceIdentifier property.

Declaration

public static readonly EntityProperty WorkflowInstanceIdentifierProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

Properties

ApprovedDate

Gets or sets the ApprovedDate associated with this DocumentEntity.

Declaration

public DateTime? ApprovedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The ApprovedDate.

AwardYear

Gets or sets the AwardYear associated with this DocumentEntity.

Declaration

public string AwardYear { get; set; }

Property Value

Type	Description
System.String	The AwardYear.

CreatedByUserId

Gets or sets the CreatedByUserId associated with this DocumentEntity.

Declaration

public int? CreatedByUserId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The CreatedByUserId.

CreatedDateTime

Gets or sets the CreatedDateTime associated with this DocumentEntity.

Declaration

public DateTime CreatedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The CreatedDateTime.

DocumentImage

Gets or sets the DocumentImage associated with this DocumentEntity.

Declaration

public byte[] DocumentImage { get; set; }

Property Value

Type	Description
System.Byte[]	The DocumentImage.

DocumentScheduleId

Gets or sets the DocumentScheduleId associated with this DocumentEntity.

Declaration

public int? DocumentScheduleId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The DocumentScheduleId.

DocumentStatusId

Gets or sets the DocumentStatusId associated with this DocumentEntity.

Declaration

public int DocumentStatusId { get; set; }

Property Value

Type	Description
System.Int32	The DocumentStatusId.

DocumentTranscriptRequest

Declaration

public virtual DocumentTranscriptRequestEntity DocumentTranscriptRequest { get; set; }

Property Value

Type	Description
DocumentTranscriptRequestEntity

DocumentTranscriptRequestId

Gets or sets the DocumentTranscriptRequestId associated with this DocumentEntity.

Declaration

public int? DocumentTranscriptRequestId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The DocumentTranscriptRequestId.

DocumentTriggerId

Gets or sets the DocumentTriggerId associated with this DocumentEntity.

Declaration

public int? DocumentTriggerId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The DocumentTriggerId.

DocumentTypeId

Gets or sets the DocumentTypeId associated with this DocumentEntity.

Declaration

public int DocumentTypeId { get; set; }

Property Value

Type	Description
System.Int32	The DocumentTypeId.

DueDate

Gets or sets the DueDate associated with this DocumentEntity.

Declaration

public DateTime? DueDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The DueDate.

ExpiresDate

Gets or sets the ExpiresDate associated with this DocumentEntity.

Declaration

public DateTime? ExpiresDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The ExpiresDate.

Id

Gets or sets the Id associated with this DocumentEntity.

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32	The Id.

ImageNowDocId0

Gets or sets the ImageNowDocId0 associated with this DocumentEntity.

Declaration

public string ImageNowDocId0 { get; set; }

Property Value

Type	Description
System.String	The ImageNowDocId0.

ImageNowDocId1

Gets or sets the ImageNowDocId1 associated with this DocumentEntity.

Declaration

public string ImageNowDocId1 { get; set; }

Property Value

Type	Description
System.String	The ImageNowDocId1.

ImageType

Gets or sets the ImageType associated with this DocumentEntity.

Declaration

public string ImageType { get; set; }

Property Value

Type	Description
System.String	The ImageType.

IsDocumentAddedManually

Gets or sets the IsDocumentAddedManually associated with this DocumentEntity.

Declaration

public bool? IsDocumentAddedManually { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The IsDocumentAddedManually.

IsPermit

Gets or sets the IsPermit associated with this DocumentEntity.

Declaration

public bool IsPermit { get; set; }

Property Value

Type	Description
System.Boolean	The IsPermit.

LastModifiedDateTime

Gets or sets the LastModifiedDateTime associated with this DocumentEntity.

Declaration

public DateTime LastModifiedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The LastModifiedDateTime.

LastModifiedUserId

Gets or sets the LastModifiedUserId associated with this DocumentEntity.

Declaration

public int LastModifiedUserId { get; set; }

Property Value

Type	Description
System.Int32	The LastModifiedUserId.

ModuleId

Gets or sets the ModuleId associated with this DocumentEntity.

Declaration

public int ModuleId { get; set; }

Property Value

Type	Description
System.Int32	The ModuleId.

Note

Gets or sets the Note associated with this DocumentEntity.

Declaration

public string Note { get; set; }

Property Value

Type	Description
System.String	The Note.

OriginalFileName

Gets or sets the OriginalFileName associated with this DocumentEntity.

Declaration

public string OriginalFileName { get; set; }

Property Value

Type	Description
System.String	The OriginalFileName.

ReceivedDate

Gets or sets the ReceivedDate associated with this DocumentEntity.

Declaration

public DateTime? ReceivedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The ReceivedDate.

RequestedDate

Gets or sets the RequestedDate associated with this DocumentEntity.

Declaration

public DateTime? RequestedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The RequestedDate.

RowVersion

Gets or sets the RowVersion associated with this DocumentEntity.

Declaration

public byte[] RowVersion { get; set; }

Property Value

Type	Description
System.Byte[]	The RowVersion.

Scanned

Gets or sets the Scanned associated with this DocumentEntity.

Declaration

public bool Scanned { get; set; }

Property Value

Type	Description
System.Boolean	The Scanned.

SentDate

Gets or sets the SentDate associated with this DocumentEntity.

Declaration

public DateTime? SentDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>	The SentDate.

StudentCourseDocumentPermits

Declaration

public virtual EntityCollection<StudentCourseDocumentPermitEntity> StudentCourseDocumentPermits { get; set; }

Property Value

Type	Description
Cmc.Core.EntityModel.EntityCollection<StudentCourseDocumentPermitEntity>

StudentEnrollmentPeriodId

Gets or sets the StudentEnrollmentPeriodId associated with this DocumentEntity.

Declaration

public int? StudentEnrollmentPeriodId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The StudentEnrollmentPeriodId.

StudentId

Gets or sets the StudentId associated with this DocumentEntity.

Declaration

public int StudentId { get; set; }

Property Value

Type	Description
System.Int32	The StudentId.

StudentPlacementId

Gets or sets the StudentPlacementId associated with this DocumentEntity.

Declaration

public int? StudentPlacementId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The StudentPlacementId.

WorkflowInstanceIdentifier

Gets or sets the WorkflowInstanceIdentifier associated with this DocumentEntity.

Declaration

public Guid? WorkflowInstanceIdentifier { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>	The WorkflowInstanceIdentifier.

Methods

GeneratedInitializer()

This is the auto-generated initializer that knows how to deal with any relationship initialization for auto-generated relationships.

Declaration

public void GeneratedInitializer()

Implements

Cmc.Core.ComponentModel.IIdentifiable

Cmc.Core.ComponentModel.IAuditable