Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
BulkSummary Class Reference
Inheritance diagram for BulkSummary:
DataObject BulkSummaryInterface ExtensibleDataInterface Detailed Short

Public Member Functions

 getBulkId ()
 
 setBulkId ($bulkUuid)
 
 getDescription ()
 
 setDescription ($description)
 
 getStartTime ()
 
 setStartTime ($timestamp)
 
 getUserId ()
 
 setUserId ($userId)
 
 getUserType ()
 
 setUserType ($userType)
 
 getOperationCount ()
 
 setOperationCount ($operationCount)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\AsynchronousOperations\Api\Data\BulkSummaryExtensionInterface $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 BulkSummaryInterface
const BULK_ID = 'uuid'
 
const DESCRIPTION = 'description'
 
const START_TIME = 'start_time'
 
const USER_ID = 'user_id'
 
const OPERATION_COUNT = 'operation_count'
 
const NOT_STARTED = 0
 
const IN_PROGRESS = 1
 
const FINISHED_SUCCESSFULLY = 2
 
const FINISHED_WITH_FAILURE = 3
 
- 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 BulkSummary

Definition at line 15 of file BulkSummary.php.

Member Function Documentation

◆ getBulkId()

getBulkId ( )

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 20 of file BulkSummary.php.

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

◆ getDescription()

getDescription ( )

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 36 of file BulkSummary.php.

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

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object.

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

Definition at line 118 of file BulkSummary.php.

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

◆ getOperationCount()

getOperationCount ( )

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 100 of file BulkSummary.php.

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

◆ getStartTime()

getStartTime ( )

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 52 of file BulkSummary.php.

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

◆ getUserId()

getUserId ( )

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 68 of file BulkSummary.php.

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

◆ getUserType()

getUserType ( )

@inheritDoc

Definition at line 84 of file BulkSummary.php.

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

◆ setBulkId()

setBulkId (   $bulkUuid)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 28 of file BulkSummary.php.

29  {
30  return $this->setData(self::BULK_ID, $bulkUuid);
31  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setDescription()

setDescription (   $description)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 44 of file BulkSummary.php.

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

◆ setExtensionAttributes()

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

Set an extension attributes object.

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

Definition at line 129 of file BulkSummary.php.

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

◆ setOperationCount()

setOperationCount (   $operationCount)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 108 of file BulkSummary.php.

109  {
110  return $this->setData(self::OPERATION_COUNT, $operationCount);
111  }
setData($key, $value=null)
Definition: DataObject.php:72

◆ setStartTime()

setStartTime (   $timestamp)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 60 of file BulkSummary.php.

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

◆ setUserId()

setUserId (   $userId)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 76 of file BulkSummary.php.

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

◆ setUserType()

setUserType (   $userType)

@inheritDoc

Definition at line 92 of file BulkSummary.php.

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

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