//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_ManagedElement.cs
//
//  Contents:   ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.
//              This file was automatically generated from CIM_ManagedElement.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>
	///ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ManagedElement")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_ManagedElement", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ManagedElement", IsNullable=false)]
	public class CIM_ManagedElement : CimBase
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_ManagedElement() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_ManagedElement(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_ManagedElement(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove Caption field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveCaption()
		{
			RemoveField("Caption");
		}

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

		/// <summary>
		/// Optional, The Caption property is a short textual description (one- line string) of the object.
		/// </summary>
		[CimField(false, false)]
		public virtual string Caption
		{
			get
			{
				return this.GetField("Caption")[0];
			}
			set
			{
			this.SetOrAddField("Caption",value);
			}
		}
		/// <summary>
		/// Remove Description field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveDescription()
		{
			RemoveField("Description");
		}

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

		/// <summary>
		/// Optional, The Description property provides a textual description of the object.
		/// </summary>
		[CimField(false, false)]
		public virtual string Description
		{
			get
			{
				return this.GetField("Description")[0];
			}
			set
			{
			this.SetOrAddField("Description",value);
			}
		}
		/// <summary>
		/// Remove ElementName field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveElementName()
		{
			RemoveField("ElementName");
		}

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

		/// <summary>
		/// Optional, A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. 
		/// Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.
		/// </summary>
		[CimField(false, false)]
		public virtual string ElementName
		{
			get
			{
				return this.GetField("ElementName")[0];
			}
			set
			{
			this.SetOrAddField("ElementName",value);
			}
		}
		/// <summary>
		/// Remove InstanceID field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveInstanceID()
		{
			RemoveField("InstanceID");
		}

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

		/// <summary>
		/// Optional, InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
		/// 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. 
		/// If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the &lt;OrgID&gt; set to CIM.
		/// </summary>
		[CimField(false, false)]
		public virtual string InstanceID
		{
			get
			{
				return this.GetField("InstanceID")[0];
			}
			set
			{
			this.SetOrAddField("InstanceID",value);
			}
		}

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

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


		/// <summary>
		/// Delete the instance of CIM_ManagedElement 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 void Delete(IWSManClient client)
		{
			CimBase.Delete<CIM_ManagedElement>(client);
		}


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

		public new class CimKeys : CimBase.CimKeys
		{
		}

	}
}