Class ItemSearchParameters

Implements operations for and represents item search parameters.

Inheritance

System.Object

ItemSearchParameters

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Mediachase.Commerce.Catalog.Managers

Assembly: Mediachase.Commerce.dll

Version: 12.17.2

Syntax

public class ItemSearchParameters

Constructors

ItemSearchParameters()

Initializes a new instance of the ItemSearchParameters class.

Declaration

public ItemSearchParameters()

Properties

CatalogId

Gets or sets the catalog id.

Declaration

public int CatalogId { get; set; }

Property Value

Type	Description
System.Int32	The catalog id.

MarketId

Gets or sets the parent node id.

Declaration

public string MarketId { get; set; }

Property Value

Type	Description
System.String	The parent node id.

OrderByClause

Gets or sets the order by clause.

Declaration

public string OrderByClause { get; set; }

Property Value

Type	Description
System.String	The order by clause.

ParentNodeId

Gets or sets the parent node id.

Declaration

public int ParentNodeId { get; set; }

Property Value

Type	Description
System.Int32	The parent node id.

RecordsToRetrieve

Number of records to be retrieved.

Declaration

public int RecordsToRetrieve { get; set; }

Property Value

Type	Description
System.Int32	The records to retrieve.

ReturnInactive

If true, inactive nodes/entries will be returned.

Declaration

public bool ReturnInactive { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [return inactive]; otherwise, `false`.

ReturnTotalCount

If true, total records count will be returned

Declaration

public bool ReturnTotalCount { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [return total count]; otherwise, `false`.

StartingRecord

Starting number of record to return. Should be pageSize*(pageNumber-1)+1.

Declaration

public int StartingRecord { get; set; }

Property Value

Type	Description
System.Int32	The starting record.

Remarks

Records numbering starts with 1.