//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       IPS_OptInService.cs
//
//  Contents:   Describes the user consent service. This service manages user opt-in options and sends a user consent code for KVM, redirection, and set boot options.
//              This file was automatically generated from IPS_OptInService.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>
	///Describes the user consent service. This service manages user opt-in options and sends a user consent code for KVM, redirection, and set boot options.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService")]
	[System.Xml.Serialization.XmlRootAttribute("IPS_OptInService", Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
	public class IPS_OptInService : CIM_Service
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public IPS_OptInService() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public IPS_OptInService(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_OptInService(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove CanModifyOptInPolicy field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveCanModifyOptInPolicy()
		{
			RemoveField("CanModifyOptInPolicy");
		}

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

		/// <summary>
		/// Optional, Read Only: Indicates if Modifying the OptIn Policy via WS-Management is enabled.
		/// </summary>
		[CimField(false, false)]
		public virtual byte CanModifyOptInPolicy
		{
			get
			{
					return byte.Parse(this["CanModifyOptInPolicy"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("CanModifyOptInPolicy",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove OptInCodeTimeout field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOptInCodeTimeout()
		{
			RemoveField("OptInCodeTimeout");
		}

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

		/// <summary>
		/// Optional, Indicates the idle timeout, in seconds, after which the opt-in code expires.
		/// </summary>
		[CimField(false, false)]
		public virtual uint OptInCodeTimeout
		{
			get
			{
					return uint.Parse(this["OptInCodeTimeout"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("OptInCodeTimeout",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove OptInDisplayTimeout field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOptInDisplayTimeout()
		{
			RemoveField("OptInDisplayTimeout");
		}

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

		/// <summary>
		/// Optional, Defines the maximum time between session request and session establishment (when user discloses the PIN on the Sprite or MEBx screen to the remote operator and the operator enters the PIN). When timeout expires, all displays of Sprite notifications or MEBx screens are cancelled. Intel(R) recommends a minimum of 5 minutes (300 seconds). Read Only in Client Control Mode, R/W in Admin Control Mode.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort OptInDisplayTimeout
		{
			get
			{
					return ushort.Parse(this["OptInDisplayTimeout"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("OptInDisplayTimeout",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove OptInRequired field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOptInRequired()
		{
			RemoveField("OptInRequired");
		}

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

		/// <summary>
		/// Optional, Indicates The OptIn (User Consent) Policy for Redirection operations,including KVM and IDER, or setting of boot options. This value is Read Only if the system was configured in Client Control Mode and Read-Write in Admin Control Mode and CanModifyOptInPolicy=true. The allowed values in Admin Control Mode are: None (opt-in not required for any of the features), KVM, or All (KVM+IDER+Boot options). Possible values in Client Control Mode: All.
		/// </summary>
		[CimField(false, false)]
		public virtual uint OptInRequired
		{
			get
			{
					return uint.Parse(this["OptInRequired"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("OptInRequired",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove OptInState field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOptInState()
		{
			RemoveField("OptInState");
		}

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

		/// <summary>
		/// Optional, Read Only. Indicates the state of OptIn: Not started: OptIn is required for sessions affected by OptInPolicy. Requested: a console has requested an opt-in code, but it was not displayed to the user yet. Displayed: the opt-in code was displayed to the user. Received: opt-in code was successfully entered by the console operator. opt-in is not required for additional redirection sessions until a timeout occurs. In Session: A session that uses the consent code is currently in progress
		/// </summary>
		[CimField(false, false)]
		public virtual byte OptInState
		{
			get
			{
					return byte.Parse(this["OptInState"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("OptInState",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		///Request an opt-in code. Intel(R) AMT generates code internally.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class StartOptIn_INPUT : CimParams
		{
			public StartOptIn_INPUT(string ns) : base(ns)
			{
			}

		}
		/// <summary>
		///Request an opt-in code. Intel(R) AMT generates code internally.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class StartOptIn_OUTPUT : CimParams
		{
			public StartOptIn_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///Request an opt-in code. Intel(R) AMT generates code internally.
		/// </summary>
		/// <returns>
		/// Legal values:
		/// PT_STATUS_SUCCESS : 0
		/// PT_STATUS_INTERNAL_ERROR : 1
		/// PT_STATUS_INVALID_STATE : 2
		/// PT_STATUS_BLOCKED : 3
		/// PT_STATUS_FAILED_FFS : 4
		/// Reserved : ..
		/// </returns>
		public virtual uint StartOptIn()
		{
			StartOptIn_INPUT input = new StartOptIn_INPUT(this.XmlNamespace);
			StartOptIn_OUTPUT output = new StartOptIn_OUTPUT();
			uint returnValue = base.Invoke("StartOptIn",input,out output);
			return returnValue;
		}
		/// <summary>
		///Cancel a previous opt-in code request.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class CancelOptIn_INPUT : CimParams
		{
			public CancelOptIn_INPUT(string ns) : base(ns)
			{
			}

		}
		/// <summary>
		///Cancel a previous opt-in code request.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class CancelOptIn_OUTPUT : CimParams
		{
			public CancelOptIn_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///Cancel a previous opt-in code request.
		/// </summary>
		/// <returns>
		/// Legal values:
		/// PT_STATUS_SUCCESS : 0
		/// PT_STATUS_INTERNAL_ERROR : 1
		/// PT_STATUS_INVALID_STATE : 2
		/// Reserved : ..
		/// </returns>
		public virtual uint CancelOptIn()
		{
			CancelOptIn_INPUT input = new CancelOptIn_INPUT(this.XmlNamespace);
			CancelOptIn_OUTPUT output = new CancelOptIn_OUTPUT();
			uint returnValue = base.Invoke("CancelOptIn",input,out output);
			return returnValue;
		}
		/// <summary>
		///Send the opt-in code to Intel(R) AMT.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class SendOptInCode_INPUT : CimParams
		{
			public SendOptInCode_INPUT(string ns) : base(ns)
			{
			}

			/// <summary>
			/// Optional, The opt-in code generated by Intel(R) AMT. This code is displayed on the user screen and should be entered by the remote IT technician.
			/// </summary>
			[CimField(false,false)]
			public virtual uint OptInCode
			{
				set
				{
					this.SetOrAddField("OptInCode",value.ToString(CultureInfo.InvariantCulture));
				}
			}
		}
		/// <summary>
		///Send the opt-in code to Intel(R) AMT.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService", IsNullable=false)]
		private class SendOptInCode_OUTPUT : CimParams
		{
			public SendOptInCode_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///Send the opt-in code to Intel(R) AMT.
		/// </summary>
		/// <param name="inOptInCode">Optional, IN -The opt-in code generated by Intel(R) AMT. This code is displayed on the user screen and should be entered by the remote IT technician.</param>
		/// <returns>
		/// Legal values:
		/// PT_STATUS_SUCCESS : 0
		/// PT_STATUS_INTERNAL_ERROR : 1
		/// PT_STATUS_INVALID_STATE : 2
		/// Reserved : ..
		/// PT_STATUS_DATA_MISSING : 2057
		/// Reserved1 : ..
		/// PT_STATUS_INVALID_CREDENTIALS : 2066
		/// Reserved2 : ..
		/// </returns>
		public virtual uint SendOptInCode(uint? inOptInCode)
		{
			SendOptInCode_INPUT input = new SendOptInCode_INPUT(this.XmlNamespace);
			if (inOptInCode.HasValue)
				input.OptInCode=inOptInCode.Value;
			SendOptInCode_OUTPUT output = new SendOptInCode_OUTPUT();
			uint returnValue = base.Invoke("SendOptInCode",input,out output);
			return returnValue;
		}

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

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


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


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

		public new class CimKeys : CIM_Service.CimKeys
		{
		}

	}
}