//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_OrderedComponent.cs
//
//  Contents:   CIM_OrderedComponent is a generic association used to establish 'part of' relationships between ManagedElements. It arranges the PartComponents in a specific assigned order. The semantics of the order depends on the context and use by the referencing classes. For example, if this association is used to arrange settings in a hierarchical order, then this specifies the sequence in which the settings are applied.
//              This file was automatically generated from CIM_OrderedComponent.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>
	///CIM_OrderedComponent is a generic association used to establish 'part of' relationships between ManagedElements. It arranges the PartComponents in a specific assigned order. The semantics of the order depends on the context and use by the referencing classes. For example, if this association is used to arrange settings in a hierarchical order, then this specifies the sequence in which the settings are applied.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_OrderedComponent")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_OrderedComponent", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_OrderedComponent", IsNullable=false)]
	public class CIM_OrderedComponent : CIM_Component
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_OrderedComponent() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_OrderedComponent(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_OrderedComponent(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove AssignedSequence field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveAssignedSequence()
		{
			RemoveField("AssignedSequence");
		}

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

		/// <summary>
		/// Optional, AssignedSequence is an unsigned integer 'n' that indicates the relative order of ManagedElement instances. When 'n' is a positive integer, it indicates a place in the sequence of members, with smaller integers indicating earlier positions in the sequence. The special value '0' indicates 'don't care'. If two or more members have the same non-zero sequence number, then the ordering between those members is irrelevant, but they must all be ordered at the appropriate place in the overall sequence. 
		/// 
		/// A series of examples will make ordering of members clearer: 
		/// If all members have the same sequence number, 
		/// regardless of whether it is '0' or non-zero, any 
		/// order is acceptable. 
		/// o The values: 
		/// 1:MEMBER A 
		/// 2:MEMBER B 
		/// 1:MEMBER C 
		/// 3:MEMBER D 
		/// indicate two acceptable orders: A,C,B,D or C,A,B,D, 
		/// since A and C can be ordered in either sequence, but 
		/// only at the '1' position. 
		/// 
		/// Note that the non-zero sequence numbers need not start with '1', and they need not be consecutive. All that matters is their relative magnitude.
		/// </summary>
		[CimField(false, false)]
		public virtual ulong AssignedSequence
		{
			get
			{
					return ulong.Parse(this["AssignedSequence"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("AssignedSequence",value.ToString(CultureInfo.InvariantCulture));
			}
		}

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

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


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


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

		public new class CimKeys : CIM_Component.CimKeys
		{
		}

	}
}