//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_LogEntry.cs
//
//  Contents:   The LogEntry object can describe the definitional format for entries in a Log, or can be used to instantiate the actual entries in the Log.
//              This file was automatically generated from CIM_LogEntry.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>
	///The LogEntry object can describe the definitional format for entries in a Log, or can be used to instantiate the actual entries in the Log.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_LogEntry")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_LogEntry", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_LogEntry", IsNullable=false)]
	public class CIM_LogEntry : CIM_RecordForLog
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_LogEntry() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_LogEntry(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_LogEntry(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove CreationTimeStamp field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveCreationTimeStamp()
		{
			RemoveField("CreationTimeStamp");
		}

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

		/// <summary>
		/// Optional, A LogEntry may include a timestamp for the entry.
		/// </summary>
		[CimField(false, false)]
		public virtual CimDateTime CreationTimeStamp
		{
			get
			{
					return CimDateTime.Parse(this["CreationTimeStamp"][0]);
			}
			set
			{
				this.SetOrAddField("CreationTimeStamp",value.ToString());
			}
		}


		/// <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>
		/// Remove LogInstanceID field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveLogInstanceID()
		{
			RemoveField("LogInstanceID");
		}

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

		/// <summary>
		/// Optional, The containing Log's InstanceID.
		/// </summary>
		[CimField(false, false)]
		public virtual string LogInstanceID
		{
			get
			{
				return this.GetField("LogInstanceID")[0];
			}
			set
			{
			this.SetOrAddField("LogInstanceID",value);
			}
		}
		/// <summary>
		/// Remove LogName field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveLogName()
		{
			RemoveField("LogName");
		}

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

		/// <summary>
		/// Optional, The containing Log's Name. This property is available for backwards continuity with CIM_LogRecord.
		/// </summary>
		[CimField(false, false)]
		public virtual string LogName
		{
			get
			{
				return this.GetField("LogName")[0];
			}
			set
			{
			this.SetOrAddField("LogName",value);
			}
		}
		/// <summary>
		/// Remove Message field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveMessage()
		{
			RemoveField("Message");
		}

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

		/// <summary>
		/// Optional, The formatted message. This message is constructed by combining some or all of the dynamic elements specified in the MessageArguments property with the static elements uniquely identified by the MessageID in a message registry or other catalog associated with the OwningEntity.
		/// </summary>
		[CimField(false, false)]
		public virtual string Message
		{
			get
			{
				return this.GetField("Message")[0];
			}
			set
			{
			this.SetOrAddField("Message",value);
			}
		}
		/// <summary>
		/// Remove MessageArguments field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveMessageArguments()
		{
			RemoveField("MessageArguments");
		}

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

		/// <summary>
		/// Optional, An array containing the dynamic content of the message.

		/// Each DYNAMIC_ELEMENT for the message referred to by the MessageID property shall be contained in MessageArguments whether the DYNAMIC_ELEMENT is included in the Message or not.

		/// In addition, the entries in MessageArguments need to be in the same order as the DYNAMIC_ELEMENTs.
		/// </summary>
		[CimField(false, false)]
		public virtual string[] MessageArguments
		{
			get
			{
					return CimTypesUtils.StringArrayToArray<string>(this["MessageArguments"]);
			}
			set
			{
				string[] arr = CimTypesUtils.ArrayToStringArray<string>(value);
				this.SetOrAddField("MessageArguments", arr);
			}
		}
		/// <summary>
		/// Remove MessageID field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveMessageID()
		{
			RemoveField("MessageID");
		}

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

		/// <summary>
		/// Optional, A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.
		/// </summary>
		[CimField(false, false)]
		public virtual string MessageID
		{
			get
			{
				return this.GetField("MessageID")[0];
			}
			set
			{
			this.SetOrAddField("MessageID",value);
			}
		}
		/// <summary>
		/// Remove OwningEntity field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOwningEntity()
		{
			RemoveField("OwningEntity");
		}

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

		/// <summary>
		/// Optional, A string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format.
		/// </summary>
		[CimField(false, false)]
		public virtual string OwningEntity
		{
			get
			{
				return this.GetField("OwningEntity")[0];
			}
			set
			{
			this.SetOrAddField("OwningEntity",value);
			}
		}
		/// <summary>
		/// Remove RecordID field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveRecordID()
		{
			RemoveField("RecordID");
		}

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

		/// <summary>
		/// Optional, RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries.
		/// </summary>
		[CimField(false, false)]
		public virtual string RecordID
		{
			get
			{
				return this.GetField("RecordID")[0];
			}
			set
			{
			this.SetOrAddField("RecordID",value);
			}
		}

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

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


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


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

		public new class CimKeys : CIM_RecordForLog.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);
				}
			}
		}

	}
}