Class StudentGroupEntity

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

Inheritance

System.Object

StudentGroupEntity

Implements

Cmc.Core.ComponentModel.IIdentifiable

Cmc.Core.ComponentModel.IAuditable

Namespace: Cmc.Nexus.Common.Entities

Assembly: Cmc.Nexus.Common.Contracts.dll

Syntax

public class StudentGroupEntity : Entity, IIdentifiable, IAuditable

Constructors

StudentGroupEntity()

Declaration

public StudentGroupEntity()

Fields

CampusGroupIdProperty

The CampusGroupId property.

Declaration

public static readonly EntityProperty CampusGroupIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

CodeProperty

The Code property.

Declaration

public static readonly EntityProperty CodeProperty

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

DataQueryIdentifierProperty

The DataQueryIdentifier property.

Declaration

public static readonly EntityProperty DataQueryIdentifierProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ExpirationDateProperty

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

Declaration

public static readonly EntityProperty ExpirationDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

GroupTypeProperty

The Specifies the type of group. M indicates a manual group. F indicates a frozen group. S indicates a static group. D indicates a dynamic group. D is disabled if the Allow Dynamic Groups check box is not selected when the system was configured. Once you have created or changed a group to manual, you cannot change it back to static, dynamic, or frozen. The field is disabled. property.

Declaration

public static readonly EntityProperty GroupTypeProperty

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

IsActiveProperty

The Specifies whether or not the associated record is active. property.

Declaration

public static readonly EntityProperty IsActiveProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsPortalGroupProperty

The Specifies that the group will be available to select in the CampusNexus Portal. property.

Declaration

public static readonly EntityProperty IsPortalGroupProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsPublicProperty

The Specifies whether or not a group is public or private. A public group can be accessed and used by all staff members who have view authorization. A private group can only be accessed and used by the owner and the staff members with view authorization that the owner specifies. If you are filtering, select the option is true to display only the public groups and the option is false to display only the private groups. property.

Declaration

public static readonly EntityProperty IsPublicProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsSprocQueryProperty

The IsSprocQuery property.

Declaration

public static readonly EntityProperty IsSprocQueryProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsTransferMonitoringGroupProperty

The IsTransferMonitoringGroup property.

Declaration

public static readonly EntityProperty IsTransferMonitoringGroupProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsUsedForAutoAwardCoaProperty

The Specifies whether or not the group can be used to define cost of attendance (COA) awarding and disbursement rules for the auto-awarding engine. property.

Declaration

public static readonly EntityProperty IsUsedForAutoAwardCoaProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

IsUsedForAutoAwardRulesProperty

The Specifies whether or not the group can be used to define awarding and disbursement rules for the auto-awarding engine. property.

Declaration

public static readonly EntityProperty IsUsedForAutoAwardRulesProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

JobFrequencyProperty

The Specifies how often the SQL query that generates the group is executed. The field applies only to dynamic groups. Unless you are authorized to view all job frequencies, it only displays the values that have been configured for Contact Manager for the CampusNexus Web staff group. property.

Declaration

public static readonly EntityProperty JobFrequencyProperty

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

LastRefreshDateProperty

The Specifies the last date that the SQL query that generates the list was executed. property.

Declaration

public static readonly EntityProperty LastRefreshDateProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

NameProperty

The Specifies the name of the item or person. If it is the name of a person, the name is displayed last then first name. property.

Declaration

public static readonly EntityProperty NameProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

OwnerStaffIdProperty

The OwnerStaffId property.

Declaration

public static readonly EntityProperty OwnerStaffIdProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

PreserveManualAddedStudentsOnRefreshProperty

The The check box is only displayed for dynamic and static groups. When the check box is selected, the manually added students are included in the group and the manually removed students are excluded from the group. When the check box is not selected, the manually added students are excluded from the group and the manually removed students are included in the group. property.

Declaration

public static readonly EntityProperty PreserveManualAddedStudentsOnRefreshProperty

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

SqlQueryProperty

The SqlQuery property.

Declaration

public static readonly EntityProperty SqlQueryProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

StaffAccessProperty

The StaffAccess property.

Declaration

public static readonly EntityProperty StaffAccessProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

ViewQueryProperty

The ViewQuery property.

Declaration

public static readonly EntityProperty ViewQueryProperty

Field Value

Type	Description
Cmc.Core.EntityModel.EntityProperty

Properties

CampusGroupId

Gets or sets the CampusGroupId associated with this StudentGroupEntity.

Declaration

public int? CampusGroupId { get; set; }

Property Value

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

Code

Gets or sets the Code associated with this StudentGroupEntity.

Declaration

public string Code { get; set; }

Property Value

Type	Description
System.String	The Code.

CreatedDateTime

Gets or sets the CreatedDateTime associated with this StudentGroupEntity.

Declaration

public DateTime CreatedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The CreatedDateTime.

DataQueryIdentifier

Gets or sets the DataQueryIdentifier associated with this StudentGroupEntity.

Declaration

public Guid? DataQueryIdentifier { get; set; }

Property Value

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

ExpirationDate

Gets or sets the ExpirationDate associated with this StudentGroupEntity.

Declaration

public DateTime? ExpirationDate { get; set; }

Property Value

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

GroupType

Gets or sets the GroupType associated with this StudentGroupEntity.

Declaration

public string GroupType { get; set; }

Property Value

Type	Description
System.String	The GroupType.

Id

Gets or sets the Id associated with this StudentGroupEntity.

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32	The Id.

IsActive

Gets or sets the IsActive associated with this StudentGroupEntity.

Declaration

public bool IsActive { get; set; }

Property Value

Type	Description
System.Boolean	The IsActive.

IsPortalGroup

Gets or sets the IsPortalGroup associated with this StudentGroupEntity.

Declaration

public bool IsPortalGroup { get; set; }

Property Value

Type	Description
System.Boolean	The IsPortalGroup.

IsPublic

Gets or sets the IsPublic associated with this StudentGroupEntity.

Declaration

public bool IsPublic { get; set; }

Property Value

Type	Description
System.Boolean	The IsPublic.

IsSprocQuery

Gets or sets the IsSprocQuery associated with this StudentGroupEntity.

Declaration

public bool IsSprocQuery { get; set; }

Property Value

Type	Description
System.Boolean	The IsSprocQuery.

IsTransferMonitoringGroup

Gets or sets the IsTransferMonitoringGroup associated with this StudentGroupEntity.

Declaration

public bool IsTransferMonitoringGroup { get; set; }

Property Value

Type	Description
System.Boolean	The IsTransferMonitoringGroup.

IsUsedForAutoAwardCoa

Gets or sets the IsUsedForAutoAwardCoa associated with this StudentGroupEntity.

Declaration

public bool IsUsedForAutoAwardCoa { get; set; }

Property Value

Type	Description
System.Boolean	The IsUsedForAutoAwardCoa.

IsUsedForAutoAwardRules

Gets or sets the IsUsedForAutoAwardRules associated with this StudentGroupEntity.

Declaration

public bool IsUsedForAutoAwardRules { get; set; }

Property Value

Type	Description
System.Boolean	The IsUsedForAutoAwardRules.

JobFrequency

Gets or sets the JobFrequency associated with this StudentGroupEntity.

Declaration

public string JobFrequency { get; set; }

Property Value

Type	Description
System.String	The JobFrequency.

LastModifiedDateTime

Gets or sets the LastModifiedDateTime associated with this StudentGroupEntity.

Declaration

public DateTime LastModifiedDateTime { get; set; }

Property Value

Type	Description
System.DateTime	The LastModifiedDateTime.

LastModifiedUserId

Gets or sets the LastModifiedUserId associated with this StudentGroupEntity.

Declaration

public int LastModifiedUserId { get; set; }

Property Value

Type	Description
System.Int32	The LastModifiedUserId.

LastRefreshDate

Gets or sets the LastRefreshDate associated with this StudentGroupEntity.

Declaration

public DateTime LastRefreshDate { get; set; }

Property Value

Type	Description
System.DateTime	The LastRefreshDate.

Name

Gets or sets the Name associated with this StudentGroupEntity.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The Name.

OwnerStaffId

Gets or sets the OwnerStaffId associated with this StudentGroupEntity.

Declaration

public int OwnerStaffId { get; set; }

Property Value

Type	Description
System.Int32	The OwnerStaffId.

PreserveManualAddedStudentsOnRefresh

Gets or sets the PreserveManualAddedStudentsOnRefresh associated with this StudentGroupEntity.

Declaration

public bool PreserveManualAddedStudentsOnRefresh { get; set; }

Property Value

Type	Description
System.Boolean	The PreserveManualAddedStudentsOnRefresh.

RowVersion

Gets or sets the RowVersion associated with this StudentGroupEntity.

Declaration

public byte[] RowVersion { get; set; }

Property Value

Type	Description
System.Byte[]	The RowVersion.

SqlQuery

Gets or sets the SqlQuery associated with this StudentGroupEntity.

Declaration

public string SqlQuery { get; set; }

Property Value

Type	Description
System.String	The SqlQuery.

StaffAccess

Declaration

public virtual EntityCollection<StudentGroupStaffAccessEntity> StaffAccess { get; set; }

Property Value

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

ViewQuery

Gets or sets the ViewQuery associated with this StudentGroupEntity.

Declaration

public string ViewQuery { get; set; }

Property Value

Type	Description
System.String	The ViewQuery.

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