CriteriaInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Api;

interface CriteriaInterface
{
    const PART_FIELDS = 'fields';
    const PART_FILTERS = 'filters';
    const PART_ORDERS = 'orders';
    const PART_CRITERIA_LIST = 'criteria_list';
    const PART_LIMIT = 'limit';

    const SORT_ORDER_ASC = 'ASC';
    const SORT_ORDER_DESC = 'DESC';

    public function getMapperInterfaceName();

    public function addField($field, $alias = null);

    public function addFilter($name, $field, $condition = null, $type = 'and');

    public function addOrder($field, $direction = self::SORT_ORDER_DESC, $unShift = false);

    public function setLimit($offset, $size);

    public function removeField($field, $isAlias = false);

    public function removeAllFields();

    public function removeFilter($name);

    public function removeAllFilters();

    public function getCriteriaList();

    public function getFilters();

    public function getOrders();

    public function getLimit();

    public function getPart($name, $default = null);

    public function toArray();

    public function reset();
}