API Documentation
Back to top  

OrderStatusInterface

Extends

Interface OrderStatusInterface

category

System
package

OrderStatus
subpackage

Entities

Methods

Returns the order status label-color.

getColor() : string

Response

string

Color of order status label.

Returns the order status id.

getId() : integer|null

Response

integer|null

Returns the order status name by the given language id.

getName(\LanguageCode $languageCode) : string
Throws
\Exception

If no name exists by the given language code.

Arguments

$languageCode

\LanguageCode

Expected language code.

Response

string

Expected status name by given language id.

Returns the order status names.

getNames() : array

Response

array

Order status names.

Sets the order status label-color.

setColor(\StringType $color) : $this|\OrderStatus

Arguments

$color

\StringType

New color of order status label.

Response

$this|\OrderStatus

Same instance for chained method calls.

Sets the order status name.

setName(\LanguageCode $languageCode, \StringType $name) : $this|\OrderStatus

Arguments

$languageCode

\LanguageCode

Language code of order status name.

$name

\StringType

Order status name.

Response

$this|\OrderStatus

Same instance for chained method calls.