//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       AMT_SystemPowerScheme.cs
//
//  Contents:   Represents a system power scheme
//              This file was automatically generated from AMT_SystemPowerScheme.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>
	///Represents a system power scheme
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SystemPowerScheme")]
	[System.Xml.Serialization.XmlRootAttribute("AMT_SystemPowerScheme", Namespace="http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SystemPowerScheme", IsNullable=false)]
	public class AMT_SystemPowerScheme : CIM_SettingData
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public AMT_SystemPowerScheme() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public AMT_SystemPowerScheme(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 AMT_SystemPowerScheme(IWSManClient client): base(client)
		{
		}


		/// <summary>
		/// Required, The user friendly name for this instance of SettingData. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)
		/// </summary>
		[CimField(false, true)]
		public override string ElementName
		{
			get
			{
				return this.GetField("ElementName")[0];
			}
			set
			{
			this.SetOrAddField("ElementName",value);
			}
		}


		/// <summary>
		/// Key, Required, Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: 
		/// &lt;OrgID&gt;:&lt;LocalID&gt; 
		/// Where &lt;OrgID&gt; and &lt;LocalID&gt; are separated by a colon ':', and where &lt;OrgID&gt; MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the &lt;Schema Name&gt;_&lt;Class Name&gt; structure of Schema class names.) In addition, to ensure uniqueness &lt;OrgID&gt; MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between &lt;OrgID&gt; and &lt;LocalID&gt;. 
		/// &lt;LocalID&gt; is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. 
		/// For DMTF defined instances, the 'preferred' algorithm MUST be used with the &lt;OrgID&gt; set to 'CIM'.
		/// </summary>
		[CimField(true, true)]
		public override string InstanceID
		{
			get
			{
				return this.GetField("InstanceID")[0];
			}
			set
			{
			this.SetOrAddField("InstanceID",value);
			}
		}


		/// <summary>
		/// Key, Required, A unique configuration identifier for the power package encoded as Base64.
		/// </summary>
		[CimField(true, true)]
		public virtual string SchemeGUID
		{
			get
			{
				return this.GetField("SchemeGUID")[0];
			}
			set
			{
			this.SetOrAddField("SchemeGUID",value);
			}
		}
		/// <summary>
		///This method activates this scheme. The IsCurrent property of CIM_ElementSettingData class that is associated to this scheme will be changed. All other schemes will be deactivated. The method returns zero on success, a positive number on failure.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SystemPowerScheme", IsNullable=false)]
		private class SetPowerScheme_INPUT : CimParams
		{
			public SetPowerScheme_INPUT(string ns) : base(ns)
			{
			}

		}
		/// <summary>
		///This method activates this scheme. The IsCurrent property of CIM_ElementSettingData class that is associated to this scheme will be changed. All other schemes will be deactivated. The method returns zero on success, a positive number on failure.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SystemPowerScheme", IsNullable=false)]
		private class SetPowerScheme_OUTPUT : CimParams
		{
			public SetPowerScheme_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///This method activates this scheme. The IsCurrent property of CIM_ElementSettingData class that is associated to this scheme will be changed. All other schemes will be deactivated. The method returns zero on success, a positive number on failure.
		/// </summary>
		/// <returns>
		/// Legal values:
		/// PT_STATUS_SUCCESS : 0
		/// PT_STATUS_INTERNAL_ERROR : 1
		/// PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED : 38
		/// PT_STATUS_AUDIT_FAIL : 2075
		/// </returns>
		public virtual uint SetPowerScheme()
		{
			SetPowerScheme_INPUT input = new SetPowerScheme_INPUT(this.XmlNamespace);
			SetPowerScheme_OUTPUT output = new SetPowerScheme_OUTPUT();
			uint returnValue = base.Invoke("SetPowerScheme",input,out output);
			return returnValue;
		}

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

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


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


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

		public new class CimKeys : CIM_SettingData.CimKeys
		{
			/// <summary>
			/// Key, Required, Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: 
			/// &lt;OrgID&gt;:&lt;LocalID&gt; 
			/// Where &lt;OrgID&gt; and &lt;LocalID&gt; are separated by a colon ':', and where &lt;OrgID&gt; MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the &lt;Schema Name&gt;_&lt;Class Name&gt; structure of Schema class names.) In addition, to ensure uniqueness &lt;OrgID&gt; MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between &lt;OrgID&gt; and &lt;LocalID&gt;. 
			/// &lt;LocalID&gt; is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. 
			/// For DMTF defined instances, the 'preferred' algorithm MUST be used with the &lt;OrgID&gt; set to 'CIM'.
			/// </summary>

			public virtual string InstanceID
			{
				get
				{
					return GetKey("InstanceID");
				}
				set
				{
					SetOrAddKey("InstanceID", value);
				}
			}
			/// <summary>
			/// Key, Required, A unique configuration identifier for the power package encoded as Base64.
			/// </summary>

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

	}
}