<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Data;

/**
* Interface SearchResultProcessorInterface
*/
interface SearchResultProcessorInterface
{
/**
* Retrieve all ids for collection
*
* @return array
*/
public function getAllIds();

/**
* Get current collection page
*
* @return int
*/
public function getCurrentPage();

/**
* Retrieve collection page size
*
* @return int
*/
public function getPageSize();

/**
* Retrieve collection first item
*
* @return \Magento\Framework\DataObject
*/
public function getFirstItem();

/**
* Retrieve collection last item
*
* @return \Magento\Framework\DataObject
*/
public function getLastItem();

/**
* Retrieve field values from all items
*
* @param string $colName
* @return array
*/
public function getColumnValues($colName);

/**
* Search all items by field value
*
* @param string $column
* @param mixed $value
* @return array
*/
public function getItemsByColumnValue($column, $value);

/**
* Search first item by field value
*
* @param string $column
* @param mixed $value
* @return \Magento\Framework\DataObject || null
*/
public function getItemByColumnValue($column, $value);

/**
* Retrieve item by id
*
* @param mixed $idValue
* @return \Magento\Framework\DataObject
*/
public function getItemById($idValue);

/**
* Walk through the collection and run model method or external callback
* with optional arguments
*
* Returns array with results of callback for each item
*
* @param string $callback
* @param array $arguments
* @return array
*/
public function walk($callback, array $arguments = []);

/**
* Convert collection to XML
*
* @return string
*/
public function toXml();

/**
* Convert collection to array
*
* @param array $arrRequiredFields
* @return array
*/
public function toArray($arrRequiredFields = []);

/**
* Convert items array to array for select options
*
* return items array
* array(
* $index => array(
* 'value' => mixed
* 'label' => mixed
* )
* )
*
* @param string $valueField
* @param string $labelField
* @param array $additional
* @return array
*/
public function toOptionArray($valueField = null, $labelField = null, $additional = []);

/**
* Convert items array to hash for select options
*
* return items hash
* array($value => $label)
*
* @param string $valueField
* @param string $labelField
* @return array
*/
public function toOptionHash($valueField, $labelField);
}