//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_BootSourceSetting.cs
//
//  Contents:   A class derived from SettingData that provides the information necessary to describe a boot source. This may be optionally associated to a bootable logical device, such as a hard disk partition, or a network device. The information from this class instance is used by the boot manager, such as BIOS/EFI or OS Loader to initiate the boot process, when this instance appears in a BootConfigSetting collection.
//              This file was automatically generated from CIM_BootSourceSetting.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>
	///A class derived from SettingData that provides the information necessary to describe a boot source. This may be optionally associated to a bootable logical device, such as a hard disk partition, or a network device. The information from this class instance is used by the boot manager, such as BIOS/EFI or OS Loader to initiate the boot process, when this instance appears in a BootConfigSetting collection.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_BootSourceSetting")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_BootSourceSetting", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_BootSourceSetting", IsNullable=false)]
	public class CIM_BootSourceSetting : CIM_SettingData
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_BootSourceSetting() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_BootSourceSetting(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 CIM_BootSourceSetting(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove BIOSBootString field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveBIOSBootString()
		{
			RemoveField("BIOSBootString");
		}

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

		/// <summary>
		/// Optional, A string identifying the boot source which corresponds to the string used by the BIOS to uniquely name the boot source. For example, in systems which implement the BIOS Boot Specification, the string could correspond to the descString string for entries in the IPL Table or BCV Table.
		/// </summary>
		[CimField(false, false)]
		public virtual string BIOSBootString
		{
			get
			{
				return this.GetField("BIOSBootString")[0];
			}
			set
			{
			this.SetOrAddField("BIOSBootString",value);
			}
		}
		/// <summary>
		/// Remove BootString field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveBootString()
		{
			RemoveField("BootString");
		}

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

		/// <summary>
		/// Optional, A string identifying the boot source. It is typically used by the instrumentation to pass to the boot manager as a selection string. This could be a string identifying the bootable device, such as "CDROM 1", or could be an implementation specific address of a bootable partition, such as the following. "fd(64)unix root=hd(40) swap=hd(41)", or "multi(0)disk(0)rdisk(0)partition(1)\WINDOWS="Microsoft Windows XP Professional"".
		/// </summary>
		[CimField(false, false)]
		public virtual string BootString
		{
			get
			{
				return this.GetField("BootString")[0];
			}
			set
			{
			this.SetOrAddField("BootString",value);
			}
		}
		/// <summary>
		/// Remove FailThroughSupported field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveFailThroughSupported()
		{
			RemoveField("FailThroughSupported");
		}

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

		/// <summary>
		/// Optional, An enumeration indicating the behavior when the attempt to boot using the boot source fails (no media, timeout). The current values in the enumeration are: 
		/// 0 = Unknown 
		/// 1 = Is Supported 
		/// 2 = Is Not Supported. 
		/// A value of 1 (Is Supported) indicates that next boot source the boot order is used. A value of 2 (Is Not Supported) indicates that the boot order is terminated and no other boot sources associated to the same CIM_BootConfigSetting are used). The default is 1 (Is Supported)
		/// </summary>
		[CimField(false, false)]
		public virtual ushort FailThroughSupported
		{
			get
			{
					return ushort.Parse(this["FailThroughSupported"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("FailThroughSupported",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove StructuredBootString field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveStructuredBootString()
		{
			RemoveField("StructuredBootString");
		}

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

		/// <summary>
		/// Optional, A string identifying the boot source using the format "&lt;OrgID&gt;:&lt;identifier&gt;:&lt;index&gt;", in which neither &lt;OrgID&gt;, &lt;identifier&gt; or &lt;index&gt; contains a colon (":"). The value of &lt;OrgID&gt; is a copyrighted, trademarked or otherwise unique name that is owned by the entity defining the &lt;identifier&gt;, or is a registered ID that is assigned to the entity by a recognized global authority. For DMTF defined identifiers, the &lt;OrgID&gt; is set to 'CIM'. The &lt;identifiers&gt; are "Floppy", "Hard-Disk", "CD/DVD", "Network", "PCMCIA", "USB". The value of &lt;index&gt; shall be a non-zero integer.
		/// </summary>
		[CimField(false, false)]
		public virtual string StructuredBootString
		{
			get
			{
				return this.GetField("StructuredBootString")[0];
			}
			set
			{
			this.SetOrAddField("StructuredBootString",value);
			}
		}

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

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


		/// <summary>
		/// Delete the instance of CIM_BootSourceSetting 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<CIM_BootSourceSetting>(client);
		}


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

		public new class CimKeys : CIM_SettingData.CimKeys
		{
		}

	}
}