Commercetools\Api\Models\State\StateDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\State\StateDraft:

Public Member Functions
	getKey ()
	getType ()
	getName ()
	getDescription ()
	getInitial ()
	getRoles ()
	getTransitions ()
	setKey (?string $key)
	setType (?string $type)
	setName (?LocalizedString $name)
	setDescription (?LocalizedString $description)
	setInitial (?bool $initial)
	setRoles (?array $roles)
	setTransitions (?StateResourceIdentifierCollection $transitions)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_KEY = 'key'
const	FIELD_TYPE = 'type'
const	FIELD_NAME = 'name'
const	FIELD_DESCRIPTION = 'description'
const	FIELD_INITIAL = 'initial'
const	FIELD_ROLES = 'roles'
const	FIELD_TRANSITIONS = 'transitions'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 15 of file StateDraft.php.

Member Function Documentation

getDescription()

Commercetools\Api\Models\State\StateDraft::getDescription

(

)

Description of the State.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getInitial()

Commercetools\Api\Models\State\StateDraft::getInitial

(

)

Set to false if the State is not the first step in a workflow.

Returns

null|bool

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getKey()

Commercetools\Api\Models\State\StateDraft::getKey

(

)

User-defined unique identifier for the State.

Returns

null|string

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getName()

Commercetools\Api\Models\State\StateDraft::getName

(

)

Name of the State.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getRoles()

Commercetools\Api\Models\State\StateDraft::getRoles

(

)

If suitable, assign predifined roles the State can fulfill in case the State's type is LineItemState or ReviewState.

Returns

null|array

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getTransitions()

Commercetools\Api\Models\State\StateDraft::getTransitions

(

)

Define the list of States of the same type to which the current State can be transitioned to.

• If, for example, the current State is the Initial State of StateType OrderState and you want to allow the transition Initial -> Shipped, then add the StateResourceIdentifier to the Shipped OrderState to this list.
• Set to empty list for not allowing any transition from the current State and defining it as final State for a workflow.
• Do not set this field at all to turn off validation and allowing transitions to any other State of the same type as the current State.

Returns

null|StateResourceIdentifierCollection

Implemented in Commercetools\Api\Models\State\StateDraftModel.

getType()

Commercetools\Api\Models\State\StateDraft::getType

(

)

Specify to which resource or object type the State is assigned to.

Returns

null|string

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setDescription()

Commercetools\Api\Models\State\StateDraft::setDescription

(

?LocalizedString

$description

)

Parameters

?LocalizedString

$description

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setInitial()

Commercetools\Api\Models\State\StateDraft::setInitial

(

?bool

$initial

)

Parameters

?bool

$initial

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setKey()

Commercetools\Api\Models\State\StateDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setName()

Commercetools\Api\Models\State\StateDraft::setName

(

?LocalizedString

$name

)

Parameters

?LocalizedString

$name

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setRoles()

Commercetools\Api\Models\State\StateDraft::setRoles

(

?array

$roles

)

Parameters

?array

$roles

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setTransitions()

Commercetools\Api\Models\State\StateDraft::setTransitions

(

?StateResourceIdentifierCollection

$transitions

)

Parameters

?StateResourceIdentifierCollection

$transitions

Implemented in Commercetools\Api\Models\State\StateDraftModel.

setType()

Commercetools\Api\Models\State\StateDraft::setType

(

?string

$type

)

Parameters

?string

$type

Implemented in Commercetools\Api\Models\State\StateDraftModel.

Member Data Documentation

FIELD_DESCRIPTION

const Commercetools\Api\Models\State\StateDraft::FIELD_DESCRIPTION = 'description'

Definition at line 20 of file StateDraft.php.

FIELD_INITIAL

const Commercetools\Api\Models\State\StateDraft::FIELD_INITIAL = 'initial'

Definition at line 21 of file StateDraft.php.

FIELD_KEY

const Commercetools\Api\Models\State\StateDraft::FIELD_KEY = 'key'

Definition at line 17 of file StateDraft.php.

FIELD_NAME

const Commercetools\Api\Models\State\StateDraft::FIELD_NAME = 'name'

Definition at line 19 of file StateDraft.php.

FIELD_ROLES

const Commercetools\Api\Models\State\StateDraft::FIELD_ROLES = 'roles'

Definition at line 22 of file StateDraft.php.

FIELD_TRANSITIONS

const Commercetools\Api\Models\State\StateDraft::FIELD_TRANSITIONS = 'transitions'

Definition at line 23 of file StateDraft.php.

FIELD_TYPE

const Commercetools\Api\Models\State\StateDraft::FIELD_TYPE = 'type'

Definition at line 18 of file StateDraft.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/State/StateDraft.php