Class CatalogKey
Encapsulates data describing a unique key to a catalog entry.
Inheritance
System.Object
CatalogKey
Implements
System.IEquatable<CatalogKey>
System.IComparable<CatalogKey>
System.IComparable
System.Runtime.Serialization.ISerializable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Commerce.Catalog
Assembly: Mediachase.Commerce.dll
Version: 10.8.0Syntax
public class CatalogKey : IEquatable<CatalogKey>, IComparable<CatalogKey>, IComparable, ISerializableConstructors
CatalogKey(CatalogEntryDto.CatalogEntryRow)
Declaration
public CatalogKey(CatalogEntryDto.CatalogEntryRow catalogEntryRow)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogEntryDto.CatalogEntryRow | catalogEntryRow |
CatalogKey(Entry)
Declaration
public CatalogKey(Entry catalogEntry)Parameters
| Type | Name | Description |
|---|---|---|
| Entry | catalogEntry |
CatalogKey(Guid, String)
Declaration
public CatalogKey(Guid applicationId, string catalogEntryCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | applicationId | |
| System.String | catalogEntryCode |
CatalogKey(SerializationInfo, StreamingContext)
Initializes a new instance of the CatalogKey class.
Declaration
protected CatalogKey(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | The information. |
| System.Runtime.Serialization.StreamingContext | context | The context. |
Properties
ApplicationId
Gets the application id of the catalog entry.
Declaration
public Guid ApplicationId { get; }Property Value
| Type | Description |
|---|---|
| System.Guid | The application id. |
CatalogEntryCode
Gets the code of the catalog entry.
Declaration
public string CatalogEntryCode { get; }Property Value
| Type | Description |
|---|---|
| System.String | The catalog entry code. |
CreatedForEntry
If this catalog key was created for an Entry object, the object it was created for; otherwise null.
Declaration
[Obsolete("This property is no longer used. Will remain at least until February 2017.")]
public Entry CreatedForEntry { get; }Property Value
| Type | Description |
|---|---|
| Entry | The Entry object this key was created for, or null. |
CreatedForRow
If this catalog key was created for a catalog entry row, the row it was created for; otherwise null.
Declaration
[Obsolete("This property is no longer used. Will remain at least until February 2017.")]
public CatalogEntryDto.CatalogEntryRow CreatedForRow { get; }Property Value
| Type | Description |
|---|---|
| CatalogEntryDto.CatalogEntryRow | The catalog entry row this key was created for, or null. |
Methods
CompareTo(CatalogKey)
Declaration
public int CompareTo(CatalogKey other)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogKey | other |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Equals(CatalogKey)
Declaration
public bool Equals(CatalogKey other)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogKey | other |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()
GetObjectData(SerializationInfo, StreamingContext)
Declaration
public void GetObjectData(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | |
| System.Runtime.Serialization.StreamingContext | context |
Explicit Interface Implementations
IComparable.CompareTo(Object)
Declaration
int IComparable.CompareTo(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Implements
System.IEquatable<T>
System.IComparable<T>
System.IComparable
System.Runtime.Serialization.ISerializable
