API Documentation
Back to top  

SpecialOfferReadServiceInterface

Extends

Interface SpecialOfferReadServiceInterface

package

Default

Methods

Returns all special offers.

getAll(\Pager|null $pager = null, array $sorters = array()) : \SpecialOfferCollection

Arguments

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

\SpecialOfferCollection

List of special offers.

Returns all special offers that matches the given search condition.

getBy(\SpecialOfferSearchCondition $searchCondition, \Pager|null $pager = null, array $sorters = array()) : \SpecialOfferCollection

Arguments

$searchCondition

\SpecialOfferSearchCondition

Condition that must match for found items.

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

\SpecialOfferCollection

List of special offers by given conditions.

Returns a special offer by the given id.

getById(\SpecialOfferIdInterface $specialOfferId) : \SpecialOfferInterface
Throws
\SpecialOfferNotFoundException

Arguments

$specialOfferId

\SpecialOfferIdInterface

Id of expected special offer.

Response

\SpecialOfferInterface

Special offer entity by given id.