/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="foodserviceItemPortionRefId">Item portion amount</param>
///<param name="earned">Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase".</param>
///<param name="mealType">A MealType</param>
///<param name="value">A Value</param>
///
public PurchaseQuantity( string foodserviceItemPortionRefId, YesNo earned, MealTypes mealType, decimal? value )
: base(FoodDTD.PURCHASEQUANTITY)
{
this.FoodserviceItemPortionRefId = foodserviceItemPortionRefId;
this.SetEarned( earned );
this.SetMealType( mealType );
this.Value = value;
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="refId">The GUID that uniquely identifies a particular HR staff assignment.</param>
///<param name="employeePersonalRefId">This GUID referencing the parent EmployeePersonal object</param>
///<param name="description">Short assignment description</param>
///<param name="primaryAssignment">Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year.</param>
///
public EmployeeAssignment( string refId, string employeePersonalRefId, string description, YesNo primaryAssignment )
: base(Adk.SifVersion, HrfinDTD.EMPLOYEEASSIGNMENT)
{
this.RefId = refId;
this.EmployeePersonalRefId = employeePersonalRefId;
this.Description = description;
this.SetPrimaryAssignment( primaryAssignment );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="refId">The GUID that uniquely identifies a particular staff assignment.</param>
///<param name="schoolInfoRefId">The ID (GUID) that identifies the school where the staff member is assigned.</param>
///<param name="schoolYear">School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., 2007 for the 2006-07 school year).</param>
///<param name="staffPersonalRefId">ID (GUID) of this staff member, as represented in the StaffPersonal object. </param>
///<param name="primaryAssignment">Is this the staff member's primary assignment? Note: There must be one and only one instance of the object with a Yes value in this element per school year.</param>
///
public StaffAssignment( string refId, string schoolInfoRefId, int? schoolYear, string staffPersonalRefId, YesNo primaryAssignment )
: base(Adk.SifVersion, StudentDTD.STAFFASSIGNMENT)
{
this.RefId = refId;
this.SchoolInfoRefId = schoolInfoRefId;
this.SchoolYear = schoolYear;
this.StaffPersonalRefId = staffPersonalRefId;
this.SetPrimaryAssignment( primaryAssignment );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="startDate">The date on which the action begins.</param>
///<param name="endDate">The date through which the action is in effect, inclusive.</param>
///<param name="duration">Identifies the length, in school days, of the action. Note: decimal places may be used for fractions of school days.</param>
///<param name="zeroTolerance">Identifies whether or not this action was imposed as a consequence of state or local zero tolerance policies.</param>
///<param name="policeNotification">Identifies whether there was notification of local law enforcement, regardless of whether official action was taken.</param>
///<param name="arrest">Identifies whether there were any arrests.</param>
///
public IncidentAction( DateTime? startDate, DateTime? endDate, decimal? duration, YesNo zeroTolerance, YesNo policeNotification, IncidentActionArrestType arrest )
: base(StudentDTD.INCIDENTACTION)
{
this.StartDate = startDate;
this.EndDate = endDate;
this.Duration = duration;
this.SetZeroTolerance( zeroTolerance );
this.SetPoliceNotification( policeNotification );
this.SetArrest( arrest );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="type">The type of node ("Agent" or "ZIS")</param>
///<param name="sifName">The descriptive name of the SIF node (i.e. Ramsey Food Services).</param>
///<param name="sifSourceId">The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create.</param>
///<param name="sifMode">Specifies the communication mode (Pull or Push) as chosen by the message sender.</param>
///<param name="sifMaxBufferSize">Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message.</param>
///<param name="sifSleeping">This element shows whether the SIF node is ready to process messages.</param>
///
public SIF_SIFNode( SIF_SIFNodeType type, string sifName, string sifSourceId, SIFMode sifMode, int? sifMaxBufferSize, YesNo sifSleeping )
: base(InfraDTD.SIF_SIFNODE)
{
this.SetType( type );
this.SIF_Name = sifName;
this.SIF_SourceId = sifSourceId;
this.SetSIF_Mode( sifMode );
this.SIF_MaxBufferSize = sifMaxBufferSize;
this.SetSIF_Sleeping( sifSleeping );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="timetableDayIdentifier">The unique identifier for the timetable day used for the bell period (from a TimetableDayList).</param>
///<param name="timetablePeriodIdentifier">The unique identifier for the timetable period used for the bell period (from a TimetablePeriodList).</param>
///<param name="startTime">The starting time for the bell period.</param>
///<param name="endTime">The ending time for the bell period.</param>
///<param name="regularSchoolPeriod">Indicates if the bell period is part of the regular school day (i.e. is not a before or after school or break period).</param>
///<param name="instructionalMinutes">The number of minutes to be counted for instruction for the bell period.</param>
///<param name="useInAttendanceCalculations">Indicates if the bell period should be included in attendance calculations.</param>
///
public BellPeriod( string timetableDayIdentifier, string timetablePeriodIdentifier, DateTime? startTime, DateTime? endTime, YesNo regularSchoolPeriod, int? instructionalMinutes, YesNo useInAttendanceCalculations )
: base(StudentDTD.BELLPERIOD)
{
this.TimetableDayIdentifier = timetableDayIdentifier;
this.TimetablePeriodIdentifier = timetablePeriodIdentifier;
this.StartTime = startTime;
this.EndTime = endTime;
this.SetRegularSchoolPeriod( regularSchoolPeriod );
this.InstructionalMinutes = instructionalMinutes;
this.SetUseInAttendanceCalculations( useInAttendanceCalculations );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="refId">GUID that identifies food service transaction</param>
///<param name="schoolInfoRefId">GUID that identifies the school/site of account transaction</param>
///<param name="program">Program. For a description of this element, see 5.1.23 Program.</param>
///<param name="transactionDate">Date of transaction</param>
///<param name="transactionTime">Time of transaction.</param>
///<param name="customer">The customer doing the transaction. The customer can be student, staff or any other person.</param>
///<param name="fsAmount">Amount.</param>
///<param name="voided">This flag tells us if the transaction is voided.</param>
///
public FoodserviceTransaction( string refId, string schoolInfoRefId, Program program, DateTime? transactionDate, DateTime? transactionTime, Customer customer, FSAmount fsAmount, YesNo voided )
: base(Adk.SifVersion, FoodDTD.FOODSERVICETRANSACTION)
{
this.RefId = refId;
this.SchoolInfoRefId = schoolInfoRefId;
this.Program = program;
this.TransactionDate = transactionDate;
this.TransactionTime = transactionTime;
this.Customer = customer;
this.FSAmount = fsAmount;
this.SetVoided( voided );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="code">A Code</param>
///<param name="startDate">The date on which the disciplinary action begins.</param>
///<param name="endDate">The date through which the disciplinary action is in effect, inclusive.</param>
///<param name="duration">Identifies the length, in school days, of the disciplinary action. Note: decimal places may be used for fractions of school days.</param>
///<param name="zeroTolerance">Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies.</param>
///<param name="fullYearExpulsion">Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days).</param>
///<param name="shortenedExpulsion">Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district.</param>
///<param name="policeNotification">Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken.</param>
///<param name="arrest">Identifies whether or not the offender was arrested.</param>
///<param name="alternativeEducation">Identifies whether or not the offender was assigned to an Alternative Education facility.</param>
///
public Action( string code, DateTime? startDate, DateTime? endDate, decimal? duration, YesNo zeroTolerance, YesNo fullYearExpulsion, YesNo shortenedExpulsion, YesNo policeNotification, ArrestStatus arrest, YesNo alternativeEducation )
: base(StudentDTD.ACTION)
{
this.Code = code;
this.StartDate = startDate;
this.EndDate = endDate;
this.Duration = duration;
this.SetZeroTolerance( zeroTolerance );
this.SetFullYearExpulsion( fullYearExpulsion );
this.SetShortenedExpulsion( shortenedExpulsion );
this.SetPoliceNotification( policeNotification );
this.SetArrest( arrest );
this.SetAlternativeEducation( alternativeEducation );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="reportDate">Date that report snapshot was generated</param>
///<param name="schoolYear">School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year).</param>
///<param name="stateProvinceId">State assigned reporting unit number</param>
///<param name="ssn">Employee social security number</param>
///<param name="name">Name of employee.</param>
///<param name="race">Primary employee's race</param>
///<param name="certifications">Employee certification area information</param>
///<param name="salary">Employee's salary</param>
///<param name="status">A Status</param>
///<param name="leave">Is this employee on leave this year?</param>
///<param name="totalYears">Total number of years employee has been in a professional position</param>
///<param name="unitYears">Total number of years at current LEA</param>
///<param name="education">Highest level of education attained by employee.</param>
///
public EmployeeCredential( DateTime? reportDate, int? schoolYear, string stateProvinceId, string ssn, Name name, RaceType race, Certifications certifications, MonetaryAmount salary, EmploymentStatus status, YesNo leave, decimal? totalYears, decimal? unitYears, TeachingCredentialBasis education )
: base(Adk.SifVersion, ProfdevDTD.EMPLOYEECREDENTIAL)
{
this.ReportDate = reportDate;
this.SchoolYear = schoolYear;
this.StateProvinceId = stateProvinceId;
this.SSN = ssn;
this.Name = name;
this.SetRace( race );
this.Certifications = certifications;
this.Salary = salary;
this.SetStatus( status );
this.SetLeave( leave );
this.TotalYears = totalYears;
this.UnitYears = unitYears;
this.SetEducation( education );
}
/// <summary>
/// Sets the value of the <c><FullYearExpulsion></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days)."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetFullYearExpulsion( YesNo val )
{
SetField( StudentDTD.ACTION_FULLYEAREXPULSION, val );
}
/// <summary>
/// Sets the value of the <c><AlternativeEducation></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was assigned to an Alternative Education facility."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetAlternativeEducation( YesNo val )
{
SetField( StudentDTD.ACTION_ALTERNATIVEEDUCATION, val );
}
///<summary>Sets the value of the <c><TeacherAttendance></c> element.</summary>
/// <param name="CountsTowardAttendance">Designates whether this date should be counted toward student attendance.</param>
/// <param name="AttendanceValue">An AttendanceValue</param>
///<remarks>
/// <para>This form of <c>setTeacherAttendance</c> is provided as a convenience method
/// that is functionally equivalent to the <c>TeacherAttendance</c></para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.4</para>
/// </remarks>
public void SetTeacherAttendance( YesNo CountsTowardAttendance, decimal? AttendanceValue )
{
RemoveChild( StudentDTD.CALENDARDATE_TEACHERATTENDANCE);
AddChild( StudentDTD.CALENDARDATE_TEACHERATTENDANCE, new CalendarAttendance( CountsTowardAttendance, AttendanceValue ) );
}
///<summary>Sets the value of the <c><AdministratorAttendance></c> element.</summary>
/// <param name="CountsTowardAttendance">Designates whether this date should be counted toward student attendance.</param>
/// <param name="AttendanceValue">An AttendanceValue</param>
///<remarks>
/// <para>This form of <c>setAdministratorAttendance</c> is provided as a convenience method
/// that is functionally equivalent to the <c>AdministratorAttendance</c></para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.4</para>
/// </remarks>
public void SetAdministratorAttendance( YesNo CountsTowardAttendance, decimal? AttendanceValue )
{
RemoveChild( StudentDTD.CALENDARDATE_ADMINISTRATORATTENDANCE);
AddChild( StudentDTD.CALENDARDATE_ADMINISTRATORATTENDANCE, new CalendarAttendance( CountsTowardAttendance, AttendanceValue ) );
}
/// <summary>
/// Sets the value of the <c><HispanicLatino></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>Version: 2.6</para>
/// <para>Since: 2.4</para>
/// </remarks>
public void SetHispanicLatino( YesNo val )
{
SetField( EtranscriptsDTD.DEMOGRAPHICSDATA_HISPANICLATINO, val );
}
/// <summary>
/// Sets the value of the <c>Secure</c> attribute.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this attribute as: "Indicates if the protocol provides a secure channel"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 1.1</para>
/// </remarks>
public void SetSecure( YesNo val )
{
SetField( InfraDTD.SIF_PROTOCOL_SECURE, val );
}
/// <summary>
/// Sets the value of the <c><ZeroTolerance></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetZeroTolerance( YesNo val )
{
SetField( StudentDTD.ACTION_ZEROTOLERANCE, val );
}
/// <summary>
/// Sets the value of the <c><CountsTowardAttendance></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Designates whether this date should be counted toward administrator attendance."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetCountsTowardAttendance( YesNo val )
{
SetField( StudentDTD.ADMINISTRATORATTENDANCE_COUNTSTOWARDATTENDANCE, val );
}
/// <summary>
/// Sets the value of the <c><Boarders></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Indicates whether the school supports boarders or not. CBDS: S21"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetBoarders( YesNo val )
{
SetField( SchoolDTD.SCHOOLINFO_BOARDERS, val );
}
/// <summary>
/// Sets the value of the <c><CountsTowardAttendance></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Designates whether this date should be counted toward student attendance."</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetCountsTowardAttendance( YesNo val )
{
SetField( StudentDTD.STUDENTATTENDANCE_COUNTSTOWARDATTENDANCE, val );
}
/// <summary>
/// Sets the value of the <c><NonUKSystemImmigrant></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Indicates the learner has recently arrived from a non-English or other common UK language system. CBDS: 190080, P170"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetNonUKSystemImmigrant( YesNo val )
{
SetField( CommonDTD.DEMOGRAPHICS_NONUKSYSTEMIMMIGRANT, val );
}
/// <summary>
/// Sets the value of the <c><PrimaryAssignment></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetPrimaryAssignment( YesNo val )
{
SetField( HrfinDTD.EMPLOYEEASSIGNMENT_PRIMARYASSIGNMENT, val );
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="type">Identifies the type being used (e.g. "HTTP", "HTTPS", "MSMQ", etc.)</param>
///<param name="secure">Indicates if the protocol provides a secure channel</param>
///
public SIF_Protocol( string type, YesNo secure )
: base(InfraDTD.SIF_PROTOCOL)
{
this.Type = type;
this.SetSecure( secure );
}
/// <summary>
/// Sets the value of the <c><PoliceNotification></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetPoliceNotification( YesNo val )
{
SetField( StudentDTD.ACTION_POLICENOTIFICATION, val );
}
/// <summary>
/// Sets the value of the <c><SIF_MorePackets></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "This element provides an indication as to whether there are more packets besides this one to make up a complete event."</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.3</para>
/// </remarks>
public void SetSIF_MorePackets( YesNo val )
{
SetField( InfraDTD.SIF_SERVICENOTIFY_SIF_MOREPACKETS, val );
}
/// <summary>
/// Sets the value of the <c><ShortenedExpulsion></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district."</para>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetShortenedExpulsion( YesNo val )
{
SetField( StudentDTD.ACTION_SHORTENEDEXPULSION, val );
}
/// <summary>
/// Sets the value of the <c><Excluded></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>Version: 2.5</para>
/// <para>Since: 1.5r1</para>
/// </remarks>
public void SetExcluded( YesNo val )
{
SetField( DwDTD.AGGREGATESTATISTICFACT_EXCLUDED, val );
}
/// <summary>
/// Sets the value of the <c><Nursery></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Indicates whether the school maintains a nursery class or not. Must be NO if Phase is set to MP, MS or SY. Must be YES if Phase is set to NY or EY. CBDS: S14"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetNursery( YesNo val )
{
SetField( SchoolDTD.SCHOOLINFO_NURSERY, val );
}
/// <summary>
/// Sets the value of the <c><Refugee></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Indates the person's refugee/asylum seeker status as defined by the United Nations (Aritcle 1 of the 1951 Refugee Convention). CBDS: 100027"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetRefugee( YesNo val )
{
SetField( CommonDTD.DEMOGRAPHICS_REFUGEE, val );
}
/// <summary>
/// Sets the value of the <c><HispanicLatino></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>Version: 2.5</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetHispanicLatino( YesNo val )
{
SetField( StudentDTD.STUDENTSNAPSHOT_HISPANICLATINO, val );
}
/// <summary>
/// Sets the value of the <c><Special></c> element.
/// </summary>
/// <param name="val">A YesNo object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "Indicates whether the school has a special class/unit or not. Must be Yes if Phase = SP. Any details will be stored in the associated SchoolInfoDetail object. CBDS: S15"</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.0</para>
/// </remarks>
public void SetSpecial( YesNo val )
{
SetField( SchoolDTD.SCHOOLINFO_SPECIAL, val );
}