OrderStatusServiceInterface
in
Interface OrderStatusServiceInterface
Tags
Table of Contents
- create() : int
- Creates a new order status.
- find() : OrderStatus|null
- Returns an order status entity by the given order status id. If no data was found, null is returned.
- findAll() : OrderStatusCollection
- Returns a collection with all order status.
- get() : OrderStatus
- Returns an order status entity by the given order status id. If no data was found, an exception is thrown.
- remove() : $this|OrderStatusServiceInterface
- Removes an order status.
- update() : $this|OrderStatusServiceInterface
- Updates an order status.
Methods
create()
Creates a new order status.
public
create(OrderStatus $orderStatus) : int
Parameters
- $orderStatus : OrderStatus
-
Order status entity with new data.
Return values
int —Id of new order status entity.
find()
Returns an order status entity by the given order status id. If no data was found, null is returned.
public
find(IntType $orderStatusId) : OrderStatus|null
Parameters
- $orderStatusId : IntType
-
Id of expected OrderStatus entity.
Return values
OrderStatus|null —Whether the found order status entity or null.
findAll()
Returns a collection with all order status.
public
findAll() : OrderStatusCollection
Return values
OrderStatusCollection —Collection of all order status resources.
get()
Returns an order status entity by the given order status id. If no data was found, an exception is thrown.
public
get(IntType $orderStatusId) : OrderStatus
Parameters
- $orderStatusId : IntType
-
Id of expected OrderStatus entity.
Tags
Return values
OrderStatus —Expected order status entity.
remove()
Removes an order status.
public
remove(IntType $orderStatusId) : $this|OrderStatusServiceInterface
Parameters
- $orderStatusId : IntType
-
Id of order status entity to be removed.
Return values
$this|OrderStatusServiceInterface —Same instance for chained method calls.
update()
Updates an order status.
public
update(OrderStatus $orderStatus) : $this|OrderStatusServiceInterface
Parameters
- $orderStatus : OrderStatus
-
Order status entity with updated data.
Return values
$this|OrderStatusServiceInterface —Same instance for chained method calls.