//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       IPS_ScreenConfigurationService.cs
//
//  Contents:   Configures the screen blanking settings in the Intel(R) AMT subsystem.
//              This file was automatically generated from IPS_ScreenConfigurationService.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>
	///Configures the screen blanking settings in the Intel(R) AMT subsystem.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_ScreenConfigurationService")]
	[System.Xml.Serialization.XmlRootAttribute("IPS_ScreenConfigurationService", Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_ScreenConfigurationService", IsNullable=false)]
	public class IPS_ScreenConfigurationService : CIM_Service
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public IPS_ScreenConfigurationService() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public IPS_ScreenConfigurationService(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_ScreenConfigurationService(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove CurrentState field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveCurrentState()
		{
			RemoveField("CurrentState");
		}

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

		/// <summary>
		/// Optional, Indicates if currently screen blanking session is open. This property is read only.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort CurrentState
		{
			get
			{
					return ushort.Parse(this["CurrentState"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("CurrentState",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove EnabledState field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveEnabledState()
		{
			RemoveField("EnabledState");
		}

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

		/// <summary>
		/// Optional, Indicates if currently screen blanking is enabled, i.e. screen blanking session can be opened.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort EnabledState
		{
			get
			{
					return ushort.Parse(this["EnabledState"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("EnabledState",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove RemainingConsecutiveRebootsNum field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveRemainingConsecutiveRebootsNum()
		{
			RemoveField("RemainingConsecutiveRebootsNum");
		}

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

		/// <summary>
		/// Optional, number of remaining conscutive reboots that will end the screen blanking session. If the value is 0 AMT will not blank the screen after a reboot.Only a warm reset should be counted as a reboot. Global reset or a power cycle reset will not survive the screen blanking session.This property is read only.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort RemainingConsecutiveRebootsNum
		{
			get
			{
					return ushort.Parse(this["RemainingConsecutiveRebootsNum"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("RemainingConsecutiveRebootsNum",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		///AMT will start a screen blanking session and require the GFX to blank all the screens connected to the iGFX simultaneously.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_ScreenConfigurationService", IsNullable=false)]
		private class SetSessionState_INPUT : CimParams
		{
			public SetSessionState_INPUT(string ns) : base(ns)
			{
			}

			/// <summary>
			/// Optional, Open if required to open session blanking session, Otherwise, (close session) the parameter is Close.
			/// </summary>
			[CimField(false,false)]
			public virtual byte SessionState
			{
				set
				{
					this.SetOrAddField("SessionState",value.ToString(CultureInfo.InvariantCulture));
				}
			}
			/// <summary>
			/// Optional, If SessionState is Open, reflects number of reboots session should survive.
			/// </summary>
			[CimField(false,false)]
			public virtual byte ConsecutiveRebootsNum
			{
				set
				{
					this.SetOrAddField("ConsecutiveRebootsNum",value.ToString(CultureInfo.InvariantCulture));
				}
			}
		}
		/// <summary>
		///AMT will start a screen blanking session and require the GFX to blank all the screens connected to the iGFX simultaneously.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_ScreenConfigurationService", IsNullable=false)]
		private class SetSessionState_OUTPUT : CimParams
		{
			public SetSessionState_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///AMT will start a screen blanking session and require the GFX to blank all the screens connected to the iGFX simultaneously.
		/// </summary>
		/// <param name="inSessionState">Optional, IN -Open if required to open session blanking session, Otherwise, (close session) the parameter is Close.</param>
		/// <param name="inConsecutiveRebootsNum">Optional, IN -If SessionState is Open, reflects number of reboots session should survive.</param>
		/// <returns>
		/// Legal values:
		/// PT_STATUS_SUCCESS : 0
		/// PT_STATUS_INTERNAL_ERROR : 1
		/// Reserved : 2..
		/// </returns>
		public virtual uint SetSessionState(byte inSessionState,byte inConsecutiveRebootsNum)
		{
			SetSessionState_INPUT input = new SetSessionState_INPUT(this.XmlNamespace);
			if (inSessionState != null)
				input.SessionState=inSessionState;
			if (inConsecutiveRebootsNum != null)
				input.ConsecutiveRebootsNum=inConsecutiveRebootsNum;
			SetSessionState_OUTPUT output = new SetSessionState_OUTPUT();
			uint returnValue = base.Invoke("SetSessionState",input,out output);
			return returnValue;
		}

		/// <summary>
		/// Enumerate instances of IPS_ScreenConfigurationService 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_ScreenConfigurationService objects</returns>
		public static new Collection<IPS_ScreenConfigurationService> Enumerate(IWSManClient client, CimBase.CimKeys cimKeys)
		{
			List<IPS_ScreenConfigurationService> ret = CimBase.Enumerate<IPS_ScreenConfigurationService>(client, cimKeys);
			return new Collection<IPS_ScreenConfigurationService>(ret);
		}

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


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


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

		public new class CimKeys : CIM_Service.CimKeys
		{
		}

	}
}