Class StudentContactPreferenceEntity

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

Inheritance

System.Object

StudentContactPreferenceEntity

Implements

Cmc.Core.ComponentModel.IIdentifiable

Cmc.Core.ComponentModel.IAuditable

Namespace: Cmc.Nexus.Common.Entities

Assembly: Cmc.Nexus.Common.Contracts.dll

Syntax

public class StudentContactPreferenceEntity : Entity, IIdentifiable, IAuditable

Constructors

StudentContactPreferenceEntity()

Declaration

public StudentContactPreferenceEntity()

Fields

ColumnNameProperty

The ColumnName property.

Declaration

public static readonly EntityProperty ColumnNameProperty

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

IdProperty

The Id property.

Declaration

public static readonly EntityProperty IdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsDoNotContactOverrideOnFileProperty

The Indicates if a DNC Override is on file for the student. An override document stores any exceptions to the DNC list. Students with addresses listed on the DNC list, but who permit communications from the institution, require an override to comply with FTC rules. You cannot update or modify the DNC Override option. The value is set in the Desktop Client based on the student document configuration and the document status code. For example, if the student has a document that is configured as “National Do Not Call Override Document” for the default campus, and the document status Code is set to “OK” or “REC”, then DNC Override will be set for all Contact Method sources. This value is then reflected in Contact Preferences under DNC Override. property.

Declaration

public static readonly EntityProperty IsDoNotContactOverrideOnFileProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsDoNotContactProperty

The Specifies the record should not be used to contact the student. property.

Declaration

public static readonly EntityProperty IsDoNotContactProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsPhoneNumberProperty

The IsPhoneNumber property.

Declaration

public static readonly EntityProperty IsPhoneNumberProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsPreferredProperty

The The preferred record to be used to contact the student. property.

Declaration

public static readonly EntityProperty IsPreferredProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

LastModifiedDateTimeProperty

The The date when the item or person was added or the status change was entered. 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

RowVersionProperty

The RowVersion property.

Declaration

public static readonly EntityProperty RowVersionProperty

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

StudentRelationshipAddressIdProperty

The StudentRelationshipAddressId property.

Declaration

public static readonly EntityProperty StudentRelationshipAddressIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

TableNameProperty

The TableName property.

Declaration

public static readonly EntityProperty TableNameProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

Properties

ColumnName

Gets or sets the ColumnName associated with this StudentContactPreferenceEntity.

Declaration

public string ColumnName { get; set; }

Property Value

Type	Description
System.String	The ColumnName.

CreatedDateTime

Gets or sets the CreatedDateTime associated with this StudentContactPreferenceEntity.

Declaration

public DateTime CreatedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The CreatedDateTime.

Id

Gets or sets the Id associated with this StudentContactPreferenceEntity.

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32	The Id.

IsDoNotContact

Gets or sets the IsDoNotContact associated with this StudentContactPreferenceEntity.

Declaration

public bool IsDoNotContact { get; set; }

Property Value

Type	Description
System.Boolean	The IsDoNotContact.

IsDoNotContactOverrideOnFile

Gets or sets the IsDoNotContactOverrideOnFile associated with this StudentContactPreferenceEntity.

Declaration

public bool IsDoNotContactOverrideOnFile { get; set; }

Property Value

Type	Description
System.Boolean	The IsDoNotContactOverrideOnFile.

IsPhoneNumber

Gets or sets the IsPhoneNumber associated with this StudentContactPreferenceEntity.

Declaration

public bool IsPhoneNumber { get; set; }

Property Value

Type	Description
System.Boolean	The IsPhoneNumber.

IsPreferred

Gets or sets the IsPreferred associated with this StudentContactPreferenceEntity.

Declaration

public bool IsPreferred { get; set; }

Property Value

Type	Description
System.Boolean	The IsPreferred.

LastModifiedDateTime

Gets or sets the LastModifiedDateTime associated with this StudentContactPreferenceEntity.

Declaration

public DateTime LastModifiedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The LastModifiedDateTime.

LastModifiedUserId

Gets or sets the LastModifiedUserId associated with this StudentContactPreferenceEntity.

Declaration

public int LastModifiedUserId { get; set; }

Property Value

Type	Description
System.Int32	The LastModifiedUserId.

RowVersion

Gets or sets the RowVersion associated with this StudentContactPreferenceEntity.

Declaration

public byte[] RowVersion { get; set; }

Property Value

Type	Description
System.Byte[]	The RowVersion.

StudentId

Gets or sets the StudentId associated with this StudentContactPreferenceEntity.

Declaration

public int StudentId { get; set; }

Property Value

Type	Description
System.Int32	The StudentId.

StudentRelationshipAddressId

Gets or sets the StudentRelationshipAddressId associated with this StudentContactPreferenceEntity.

Declaration

public int? StudentRelationshipAddressId { get; set; }

Property Value

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

TableName

Gets or sets the TableName associated with this StudentContactPreferenceEntity.

Declaration

public string TableName { get; set; }

Property Value

Type	Description
System.String	The TableName.

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