/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="periodIndex">Ordinal position of period within the day (1,2,3,etc)</param>
///<param name="shortName">A ShortName</param>
///<param name="longName">A LongName</param>
///<param name="type">What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school.</param>
///
public Period(int?periodIndex, string shortName, string longName, PeriodType type) : base(LearningDTD.PERIOD)
{
this.PeriodIndex = periodIndex;
this.ShortName = shortName;
this.LongName = longName;
this.SetType(type);
}
/// <summary>
/// Constructor that accepts values for all mandatory fields
/// </summary>
///<param name="periodIndex">Ordinal position of period within the day (1,2,3,etc)</param>
///<param name="shortName">A ShortName</param>
///<param name="longName">A LongName</param>
///<param name="type">What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school.</param>
///
public Period( int? periodIndex, string shortName, string longName, PeriodType type )
: base(LearningDTD.PERIOD)
{
this.PeriodIndex = periodIndex;
this.ShortName = shortName;
this.LongName = longName;
this.SetType( type );
}
/// <summary>
/// Sets the value of the <c><Type></c> element.
/// </summary>
/// <param name="val">A PeriodType object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school."</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.3</para>
/// </remarks>
public void SetType( PeriodType val )
{
SetField( LearningDTD.PERIOD_TYPE, val );
}
///<summary>Adds the value of the <c><Period></c> element.</summary>
/// <param name="PeriodIndex">Ordinal position of period within the day (1,2,3,etc)</param>
/// <param name="ShortName">A ShortName</param>
/// <param name="LongName">A LongName</param>
/// <param name="Type">What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school.</param>
///<remarks>
/// <para>This form of <c>setPeriod</c> is provided as a convenience method
/// that is functionally equivalent to the method <c>AddPeriod</c></para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.3</para>
/// </remarks>
public void AddPeriod(int?PeriodIndex, string ShortName, string LongName, PeriodType Type)
{
AddChild(LearningDTD.PERIODLIST_PERIOD, new Period(PeriodIndex, ShortName, LongName, Type));
}
/// <summary>
/// Sets the value of the <c><Type></c> element.
/// </summary>
/// <param name="val">A PeriodType object</param>
/// <remarks>
/// <para>The SIF specification defines the meaning of this element as: "What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school."</para>
/// <para>Version: 2.6</para>
/// <para>Since: 2.3</para>
/// </remarks>
public void SetType(PeriodType val)
{
SetField(LearningDTD.PERIOD_TYPE, val);
}
