Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Operation Class Reference
Inheritance diagram for Operation:
DataObject OperationInterface ExtensibleDataInterface

Public Member Functions

 getId ()
 
 setId ($id)
 
 getBulkUuid ()
 
 setBulkUuid ($bulkId)
 
 getTopicName ()
 
 setTopicName ($topic)
 
 getSerializedData ()
 
 setSerializedData ($serializedData)
 
 getResultSerializedData ()
 
 setResultSerializedData ($resultSerializedData)
 
 getStatus ()
 
 setStatus ($status)
 
 getResultMessage ()
 
 setResultMessage ($resultMessage)
 
 getErrorCode ()
 
 setErrorCode ($errorCode)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\AsynchronousOperations\Api\Data\OperationExtensionInterface $extensionAttributes)
 
- Public Member Functions inherited from DataObject
 __construct (array $data=[])
 
 addData (array $arr)
 
 setData ($key, $value=null)
 
 unsetData ($key=null)
 
 getData ($key='', $index=null)
 
 getDataByPath ($path)
 
 getDataByKey ($key)
 
 setDataUsingMethod ($key, $args=[])
 
 getDataUsingMethod ($key, $args=null)
 
 hasData ($key='')
 
 toArray (array $keys=[])
 
 convertToArray (array $keys=[])
 
 toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 toJson (array $keys=[])
 
 convertToJson (array $keys=[])
 
 toString ($format='')
 
 __call ($method, $args)
 
 isEmpty ()
 
 serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
 
 debug ($data=null, &$objects=[])
 
 offsetSet ($offset, $value)
 
 offsetExists ($offset)
 
 offsetUnset ($offset)
 
 offsetGet ($offset)
 

Additional Inherited Members

- Data Fields inherited from OperationInterface
const ID = 'id'
 
const BULK_ID = 'bulk_uuid'
 
const TOPIC_NAME = 'topic_name'
 
const SERIALIZED_DATA = 'serialized_data'
 
const RESULT_SERIALIZED_DATA = 'result_serialized_data'
 
const STATUS = 'status'
 
const RESULT_MESSAGE = 'result_message'
 
const ERROR_CODE = 'error_code'
 
const STATUS_TYPE_COMPLETE = 1
 
const STATUS_TYPE_RETRIABLY_FAILED = 2
 
const STATUS_TYPE_NOT_RETRIABLY_FAILED = 3
 
const STATUS_TYPE_OPEN = 4
 
const STATUS_TYPE_REJECTED = 5
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 
- Protected Member Functions inherited from DataObject
 _getData ($key)
 
 _underscore ($name)
 
- Protected Attributes inherited from DataObject
 $_data = []
 
- Static Protected Attributes inherited from DataObject
static $_underscoreCache = []
 

Detailed Description

Class Operation

Definition at line 14 of file Operation.php.

Member Function Documentation

◆ getBulkUuid()

getBulkUuid ( )

@inheritDoc

Implements OperationInterface.

Definition at line 35 of file Operation.php.

36  {
37  return $this->getData(self::BULK_ID);
38  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getErrorCode()

getErrorCode ( )

@inheritDoc

Implements OperationInterface.

Definition at line 131 of file Operation.php.

132  {
133  return $this->getData(self::ERROR_CODE);
134  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object.

Returns
\Magento\AsynchronousOperations\Api\Data\OperationExtensionInterface|null

Definition at line 149 of file Operation.php.

150  {
151  return $this->getData(self::EXTENSION_ATTRIBUTES_KEY);
152  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getId()

getId ( )

@inheritDoc

Implements OperationInterface.

Definition at line 19 of file Operation.php.

20  {
21  return $this->getData(self::ID);
22  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getResultMessage()

getResultMessage ( )

@inheritDoc

Implements OperationInterface.

Definition at line 115 of file Operation.php.

116  {
117  return $this->getData(self::RESULT_MESSAGE);
118  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getResultSerializedData()

getResultSerializedData ( )

@inheritDoc

Implements OperationInterface.

Definition at line 83 of file Operation.php.

84  {
85  return $this->getData(self::RESULT_SERIALIZED_DATA);
86  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getSerializedData()

getSerializedData ( )

@inheritDoc

Implements OperationInterface.

Definition at line 67 of file Operation.php.

68  {
69  return $this->getData(self::SERIALIZED_DATA);
70  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getStatus()

getStatus ( )

@inheritDoc

Implements OperationInterface.

Definition at line 99 of file Operation.php.

100  {
101  return $this->getData(self::STATUS);
102  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ getTopicName()

getTopicName ( )

@inheritDoc

Implements OperationInterface.

Definition at line 51 of file Operation.php.

52  {
53  return $this->getData(self::TOPIC_NAME);
54  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ setBulkUuid()

setBulkUuid (   $bulkId)

@inheritDoc

Implements OperationInterface.

Definition at line 43 of file Operation.php.

44  {
45  return $this->setData(self::BULK_ID, $bulkId);
46  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setErrorCode()

setErrorCode (   $errorCode)

@inheritDoc

Implements OperationInterface.

Definition at line 139 of file Operation.php.

140  {
141  return $this->setData(self::ERROR_CODE, $errorCode);
142  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\AsynchronousOperations\Api\Data\OperationExtensionInterface  $extensionAttributes)

Set an extension attributes object.

Parameters
\Magento\AsynchronousOperations\Api\Data\OperationExtensionInterface$extensionAttributes
Returns
$this

Definition at line 160 of file Operation.php.

162  {
163  return $this->setData(self::EXTENSION_ATTRIBUTES_KEY, $extensionAttributes);
164  }
$extensionAttributes
Definition: payment.php:22
setData($key, $value=null)
Definition: DataObject.php:72

◆ setId()

setId (   $id)

@inheritDoc

Implements OperationInterface.

Definition at line 27 of file Operation.php.

28  {
29  return $this->setData(self::ID, $id);
30  }
$id
Definition: fieldset.phtml:14
setData($key, $value=null)
Definition: DataObject.php:72

◆ setResultMessage()

setResultMessage (   $resultMessage)

@inheritDoc

Implements OperationInterface.

Definition at line 123 of file Operation.php.

124  {
125  return $this->setData(self::RESULT_MESSAGE, $resultMessage);
126  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setResultSerializedData()

setResultSerializedData (   $resultSerializedData)

@inheritDoc

Implements OperationInterface.

Definition at line 91 of file Operation.php.

92  {
93  return $this->setData(self::RESULT_SERIALIZED_DATA, $resultSerializedData);
94  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setSerializedData()

setSerializedData (   $serializedData)

@inheritDoc

Implements OperationInterface.

Definition at line 75 of file Operation.php.

76  {
77  return $this->setData(self::SERIALIZED_DATA, $serializedData);
78  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setStatus()

setStatus (   $status)

@inheritDoc

Implements OperationInterface.

Definition at line 107 of file Operation.php.

108  {
109  return $this->setData(self::STATUS, $status);
110  }
$status
Definition: order_status.php:8
setData($key, $value=null)
Definition: DataObject.php:72

◆ setTopicName()

setTopicName (   $topic)

@inheritDoc

Implements OperationInterface.

Definition at line 59 of file Operation.php.

60  {
61  return $this->setData(self::TOPIC_NAME, $topic);
62  }
setData($key, $value=null)
Definition: DataObject.php:72

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