\MerchantAPI\ListQueryListQueryRequestInterface

Interface ListQueryRequestInterface.

Summary

Methods

Constants

getFunction()
getStoreCode()
getScope()
setStoreCode()
toArray()
createResponse()
getSort()
setSort()
getAvailableSortFields()
getOffset()
setOffset()
getCount()
setCount()
getAvailableSearchFields()
addOnDemandColumn()
removeOnDemandColumn()
setOnDemandColumns()
getOnDemandColumns()
getAvailableOnDemandColumns()
getCustomFilters()
getAvailableCustomFilters()
setFilters()
getFilters()
setCustomFilter()
removeCustomFilter()
filterExpression()

REQUEST_SCOPE_STORE
REQUEST_SCOPE_DOMAIN
SORT_ASCENDING
SORT_DESCENDING

No protected methods found

N/A

No private methods found

N/A

Constants

REQUEST_SCOPE_STORE

REQUEST_SCOPE_STORE

REQUEST_SCOPE_DOMAIN

REQUEST_SCOPE_DOMAIN

SORT_ASCENDING

SORT_ASCENDING

Sort Constants

SORT_DESCENDING

SORT_DESCENDING

Methods

getFunction()

getFunction() : string

Returns the API function name to be executed.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getStoreCode()

getStoreCode() : mixed

Get the request level store code, if set.

Returns

mixed

getScope()

getScope() : string

Get the scope of the request. Returns a RequestInterface::REQUEST_SCOPE_* constant.

Returns

string

setStoreCode()

setStoreCode(  $storeCode) : \MerchantAPI\ResponseInterface

Override client level store code from the request. Only applies to store scoped requests.

Parameters

$storeCode

Returns

\MerchantAPI\ResponseInterface

toArray()

toArray() : array

Returns the data for the request as an array.

Returns

array

createResponse()

createResponse(\MerchantAPI\Http\HttpResponse  $httpResponse, array  $data) : \MerchantAPI\ResponseInterface

Create a response object from the http response.

Parameters

\MerchantAPI\Http\HttpResponse	$httpResponse
array	$data

Returns

\MerchantAPI\ResponseInterface

getSort()

getSort() : mixed

Get the sorting field.

Returns

mixed

setSort()

setSort(  $field,   $direction = self::SORT_ASCENDING) : $this

Set the sorting field.

Parameters

	$field
	$direction

Returns

$this

getAvailableSortFields()

getAvailableSortFields() : array

Get the available sorting fields for the request.

Returns

array

getOffset()

getOffset() : mixed

Get the record offset.

Returns

mixed

setOffset()

setOffset(mixed  $offset) : $this

Set the record offset.

Parameters

mixed

$offset

Returns

$this

getCount()

getCount() : mixed

Get the maximum records to request.

Returns

mixed

setCount()

setCount(mixed  $count) : $this

Set the maximum records to request.

Parameters

mixed

$count

Returns

$this

getAvailableSearchFields()

getAvailableSearchFields() : array

Get the available search fields for the request.

Returns

array

addOnDemandColumn()

addOnDemandColumn(  $column) : $this

Add an on demand column to the request.

Parameters

$column

Returns

$this

removeOnDemandColumn()

removeOnDemandColumn(  $column) : $this

Remove an on demand column from the request.

Parameters

$column

Returns

$this

setOnDemandColumns()

setOnDemandColumns(array  $columns) : $this

Set the on demand columns to fetch.

Parameters

array

$columns

Returns

$this

getOnDemandColumns()

getOnDemandColumns() : array

Get the on demand columns to fetch.

Returns

array

getAvailableOnDemandColumns()

getAvailableOnDemandColumns() : array

Get the available on demand columns for the request.

Returns

array

getCustomFilters()

getCustomFilters() : array

Get the custom filters to apply.

Returns

array

getAvailableCustomFilters()

getAvailableCustomFilters() : array

Get the available custom filters for the request.

Returns

array

setFilters()

setFilters(  $filters) : $this

Set the search filters to apply to the request.

Parameters

$filters

Throws

\InvalidArgumentException

Returns

$this

getFilters()

getFilters() : array|\MerchantAPI\ListQuery\FilterExpression

Get the search filters to apply to the request.

Returns

array|\MerchantAPI\ListQuery\FilterExpression

setCustomFilter()

setCustomFilter(  $name,   $value) : $this

Set a custom filter supported by the request.

Parameters

	$name
	$value

Throws

\InvalidArgumentException

Returns

$this

removeCustomFilter()

removeCustomFilter(  $name) : $this

Remove a custom filter applied to the request.

Parameters

$name

Returns

$this

filterExpression()

filterExpression() : \MerchantAPI\ListQuery\FilterExpression

Creates a new FilterExpression object in the context the request.

Returns

\MerchantAPI\ListQuery\FilterExpression