//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_Log.cs
//
//  Contents:   Log represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Log does not dictate the form of the data represented or how records/messages are stored in the log and/or accessed. Subclasses will define the appropriate methods and behavior.
//              This file was automatically generated from CIM_Log.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>
	///Log represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Log does not dictate the form of the data represented or how records/messages are stored in the log and/or accessed. Subclasses will define the appropriate methods and behavior.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Log")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_Log", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Log", IsNullable=false)]
	public class CIM_Log : CIM_EnabledLogicalElement
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_Log() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_Log(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_Log(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove CurrentNumberOfRecords field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveCurrentNumberOfRecords()
		{
			RemoveField("CurrentNumberOfRecords");
		}

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

		/// <summary>
		/// Optional, Current number of records in the Log.
		/// </summary>
		[CimField(false, false)]
		public virtual ulong CurrentNumberOfRecords
		{
			get
			{
					return ulong.Parse(this["CurrentNumberOfRecords"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("CurrentNumberOfRecords",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove LogState field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveLogState()
		{
			RemoveField("LogState");
		}

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

		/// <summary>
		/// Optional, LogState is an integer enumeration that indicates the current state of a log represented by CIM_Log subclasses. LogState is to be used in conjunction with the EnabledState property to fully describe the current state of the log. The following text briefly summarizes the various log states: 
		/// Unknown (0) indicates the state of the log is unknown. 
		/// Normal (2) indicates that the log is or could be executing logging commands, will process any queued log entries, and will queue new logging requests. 
		/// Erasing (3) indicates that the log is being erased. 
		/// Not Applicable (4) indicates the log does not support representing a log state.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort LogState
		{
			get
			{
					return ushort.Parse(this["LogState"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("LogState",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove MaxNumberOfRecords field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveMaxNumberOfRecords()
		{
			RemoveField("MaxNumberOfRecords");
		}

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

		/// <summary>
		/// Optional, Maximum number of records that can be captured in the Log. If undefined, a value of zero should be specified.
		/// </summary>
		[CimField(false, false)]
		public virtual ulong MaxNumberOfRecords
		{
			get
			{
					return ulong.Parse(this["MaxNumberOfRecords"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("MaxNumberOfRecords",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove OverwritePolicy field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOverwritePolicy()
		{
			RemoveField("OverwritePolicy");
		}

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

		/// <summary>
		/// Optional, OverwritePolicy is an integer enumeration that indicates whether the log, represented by the CIM_Log subclasses, can overwrite its entries.Unknown (0) indicates the log's overwrite policy is unknown. 
		/// Wraps when Full (2) indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity. 
		/// Never Overwrites (7) indicates that the log never overwrites its entries by the new entries.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort OverwritePolicy
		{
			get
			{
					return ushort.Parse(this["OverwritePolicy"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("OverwritePolicy",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		///Requests that the Log be cleared of all entries. 
		///The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Log", IsNullable=false)]
		private class ClearLog_INPUT : CimParams
		{
			public ClearLog_INPUT(string ns) : base(ns)
			{
			}

		}
		/// <summary>
		///Requests that the Log be cleared of all entries. 
		///The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.
		/// </summary>
		[System.SerializableAttribute()]
		[System.Xml.Serialization.XmlTypeAttribute(AnonymousType=true)]
		[System.Xml.Serialization.XmlRootAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Log", IsNullable=false)]
		private class ClearLog_OUTPUT : CimParams
		{
			public ClearLog_OUTPUT() : base("")
			{
			}

		}
		/// <summary>
		///Requests that the Log be cleared of all entries. 
		///The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.
		/// </summary>
		/// <returns>
		/// Legal values:
		/// Completed with no error : 0
		/// Not Supported : 1
		/// Unspecified Error : 2
		/// Timeout : 3
		/// Failed : 4
		/// Invalid Parameter : 5
		/// DMTF_Reserved : 6..0x0FFF
		/// Method_Reserved : 0x1000..0x7FFF
		/// Vendor_Reserved : 0x8000..
		/// </returns>
		public virtual uint ClearLog()
		{
			ClearLog_INPUT input = new ClearLog_INPUT(this.XmlNamespace);
			ClearLog_OUTPUT output = new ClearLog_OUTPUT();
			uint returnValue = base.Invoke("ClearLog",input,out output);
			return returnValue;
		}

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

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


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


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

		public new class CimKeys : CIM_EnabledLogicalElement.CimKeys
		{
		}

	}
}