Inherits from NSObject
Conforms to PicoBindable
Declared in Finding_ItemFilter.h
Finding_ItemFilter.m

Overview

Contains the specifications for limiting the number of items returned by a find request. Use itemFilter to specify name/value pairs. You can include multiple item filters in a single request.

@ingroup FindingServicePortType

Tasks

  •   paramName

    In addition to filter Name/Value pairs, some itemFilters use an
    additional parameter Name/Value pair. Specifically, filters that use
    currency values (MaxPrice and MinPrice) make use of addition parameters.
    When you use these itemFilters, set paramName to Currency and provide the
    currency ID in paramValue.



    For example, if you use the MaxPrice itemFilter, you will need to specify
    a parameter Name of Currency with a parameter Value that specifies the
    type of currency desired.



    Note that for MaxPrice and MinPrice itemFilters, the default value for
    paramName is Currency.

         property
  •   paramValue

    The currency value associated with the respective itemFilter parameter
    Name.



    Usually paramName is set to Currency and paramValue is set to the
    currency type in which the monetary transaction occurs.



    Note that for MaxPrice and MinPrice itemFilters, the default value for
    paramValue is USD.

         property
  •   name

    Specify the name of the item filter you want to use. The itemFilter name
    must have a corresponding value. You can apply multiple itemFilter
    Name/Value pairs in a single request.

         property
  •   value

    The value associated with the respective item filter name. Allowed values
    and datatypes vary for a given filter name.

         property
  •   delimiter

    (public property)

         property
  •   any

    (public property)

         property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Finding_ItemFilter.h

delimiter

(public property)

@property (nonatomic, retain) NSString *delimiter

Discussion

(public property)

type : NSString, wrapper for primitive string

Declared In

Finding_ItemFilter.h

name

Specify the name of the item filter you want to use. The itemFilter name
must have a corresponding value. You can apply multiple itemFilter
Name/Value pairs in a single request.

@property (nonatomic, retain) NSString *name

Discussion

Specify the name of the item filter you want to use. The itemFilter name
must have a corresponding value. You can apply multiple itemFilter
Name/Value pairs in a single request.

type: string constant in Finding_ItemFilterType.h

Declared In

Finding_ItemFilter.h

paramName

In addition to filter Name/Value pairs, some itemFilters use an
additional parameter Name/Value pair. Specifically, filters that use
currency values (MaxPrice and MinPrice) make use of addition parameters.
When you use these itemFilters, set paramName to Currency and provide the
currency ID in paramValue.



For example, if you use the MaxPrice itemFilter, you will need to specify
a parameter Name of Currency with a parameter Value that specifies the
type of currency desired.



Note that for MaxPrice and MinPrice itemFilters, the default value for
paramName is Currency.

@property (nonatomic, retain) NSString *paramName

Discussion

In addition to filter Name/Value pairs, some itemFilters use an
additional parameter Name/Value pair. Specifically, filters that use
currency values (MaxPrice and MinPrice) make use of addition parameters.
When you use these itemFilters, set paramName to Currency and provide the
currency ID in paramValue.



For example, if you use the MaxPrice itemFilter, you will need to specify
a parameter Name of Currency with a parameter Value that specifies the
type of currency desired.



Note that for MaxPrice and MinPrice itemFilters, the default value for
paramName is Currency.

type : NSString, wrapper for primitive string

Declared In

Finding_ItemFilter.h

paramValue

The currency value associated with the respective itemFilter parameter
Name.



Usually paramName is set to Currency and paramValue is set to the
currency type in which the monetary transaction occurs.



Note that for MaxPrice and MinPrice itemFilters, the default value for
paramValue is USD.

@property (nonatomic, retain) NSString *paramValue

Discussion

The currency value associated with the respective itemFilter parameter
Name.



Usually paramName is set to Currency and paramValue is set to the
currency type in which the monetary transaction occurs.



Note that for MaxPrice and MinPrice itemFilters, the default value for
paramValue is USD.

type : NSString, wrapper for primitive string

Declared In

Finding_ItemFilter.h

value

The value associated with the respective item filter name. Allowed values
and datatypes vary for a given filter name.

@property (nonatomic, retain) NSMutableArray *value

Discussion

The value associated with the respective item filter name. Allowed values
and datatypes vary for a given filter name.

entry type : NSString, wrapper for primitive string

Declared In

Finding_ItemFilter.h