//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       IPS_AlarmClockOccurrence.cs
//
//  Contents:   IPS_AlarmClockOccurrence represents a single alarm clock setting. An instance of this class is created by calling AMT_AlarmClockService.AddAlarm method.
//              This file was automatically generated from IPS_AlarmClockOccurrence.mof
//
//----------------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text;
using System.Globalization;
using System.Xml.Serialization;
using System.IO;
using Intel.Manageability.WSManagement;
using Intel.Manageability.Cim.Untyped;


namespace Intel.Manageability.Cim.Typed
{
	/// <summary>
	///IPS_AlarmClockOccurrence represents a single alarm clock setting. An instance of this class is created by calling AMT_AlarmClockService.AddAlarm method. 
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_AlarmClockOccurrence")]
	[System.Xml.Serialization.XmlRootAttribute("IPS_AlarmClockOccurrence", Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_AlarmClockOccurrence", IsNullable=false)]
	public class IPS_AlarmClockOccurrence : CIM_ManagedElement
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public IPS_AlarmClockOccurrence() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public IPS_AlarmClockOccurrence(string xml): base((IWSManClient)null)
		{
			this.Deserialize(xml);
		}
		/// <summary>
		/// Constructor which recieves a Ws-Management client object.
		/// </summary>
		/// <param name="client">Ws-Management client</param>
		public IPS_AlarmClockOccurrence(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove DeleteOnCompletion field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveDeleteOnCompletion()
		{
			RemoveField("DeleteOnCompletion");
		}

		/// <summary>
		/// Is true if the field DeleteOnCompletion exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool DeleteOnCompletionExist
		{
			get
			{
				return ContainsField("DeleteOnCompletion");
			}
		}

		/// <summary>
		/// Optional, if set to TRUE, the instance will be deleted by the FW when the alarm is completed. Otherwise, the SW can delete the instance using the Delete() method.
		/// </summary>
		[CimField(false, false)]
		public virtual bool DeleteOnCompletion
		{
			get
			{
				return bool.Parse(this["DeleteOnCompletion"][0]);
			}
			set
			{
				this.SetOrAddField("DeleteOnCompletion",value.ToString().ToLower(CultureInfo.InvariantCulture));
			}
		}


		/// <summary>
		/// Key, Required, The instance key, set by the caller of AMT_AlarmClockService.AddAlarm.
		/// </summary>
		[CimField(true, true)]
		public virtual string InstanceID
		{
			get
			{
				return this.GetField("InstanceID")[0];
			}
			set
			{
			this.SetOrAddField("InstanceID",value);
			}
		}
		/// <summary>
		/// Remove Interval field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveInterval()
		{
			RemoveField("Interval");
		}

		/// <summary>
		/// Is true if the field Interval exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool IntervalExist
		{
			get
			{
				return ContainsField("Interval");
			}
		}

		/// <summary>
		/// Optional, The interval between occurrences of the alarm (0 if the alarm is scheduled to run once).
		/// </summary>
		[CimField(false, false)]
		public virtual CimDateTime Interval
		{
			get
			{
					return CimDateTime.Parse(this["Interval"][0]);
			}
			set
			{
				this.SetOrAddField("Interval",value.ToString());
			}
		}
		/// <summary>
		/// Remove StartTime field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveStartTime()
		{
			RemoveField("StartTime");
		}

		/// <summary>
		/// Is true if the field StartTime exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool StartTimeExist
		{
			get
			{
				return ContainsField("StartTime");
			}
		}

		/// <summary>
		/// Optional, The next time when the alarm is scheduled to be set.
		/// </summary>
		[CimField(false, false)]
		public virtual CimDateTime StartTime
		{
			get
			{
					return CimDateTime.Parse(this["StartTime"][0]);
			}
			set
			{
				this.SetOrAddField("StartTime",value.ToString());
			}
		}

		/// <summary>
		/// Enumerate instances of IPS_AlarmClockOccurrence class at an endpoint.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		/// <param name="cimKeys">Keys for selecting the instances</param>
		/// <returns>Collection of IPS_AlarmClockOccurrence objects</returns>
		public static new Collection<IPS_AlarmClockOccurrence> Enumerate(IWSManClient client, CimBase.CimKeys cimKeys)
		{
			List<IPS_AlarmClockOccurrence> ret = CimBase.Enumerate<IPS_AlarmClockOccurrence>(client, cimKeys);
			return new Collection<IPS_AlarmClockOccurrence>(ret);
		}

		/// <summary>
		/// Enumerate instances of IPS_AlarmClockOccurrence class at an endpoint.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		/// <returns>Collection of IPS_AlarmClockOccurrence objects</returns>
		public static new Collection<IPS_AlarmClockOccurrence> Enumerate(IWSManClient client)
		{
			List<IPS_AlarmClockOccurrence> ret = CimBase.Enumerate<IPS_AlarmClockOccurrence>(client);
			return new Collection<IPS_AlarmClockOccurrence>(ret);
		}


		/// <summary>
		/// Delete the instance of IPS_AlarmClockOccurrence if it is singular.
		/// Note: This method will succeed only if a single instance of the class exists.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		public static new void Delete(IWSManClient client)
		{
			CimBase.Delete<IPS_AlarmClockOccurrence>(client);
		}


		/// <summary>
		/// Represents the keys of the IPS_AlarmClockOccurrence class.
		/// </summary>

		public new class CimKeys : CIM_ManagedElement.CimKeys
		{
			/// <summary>
			/// Key, Required, The instance key, set by the caller of AMT_AlarmClockService.AddAlarm.
			/// </summary>

			public virtual string InstanceID
			{
				get
				{
					return GetKey("InstanceID");
				}
				set
				{
					SetOrAddKey("InstanceID", value);
				}
			}
		}

	}
}