1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Api\Data;
/**
* Credit memo comment interface.
*
* After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo
* to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the
* customer account so that the customer can make future purchases. A credit memo usually includes comments that detail
* why the credit memo amount was credited to the customer.
* @api
* @since 100.0.2
*/
interface CreditmemoCommentInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case.
*/
/*
* Entity ID.
*/
const ENTITY_ID = 'entity_id';
/*
* Parent ID.
*/
const PARENT_ID = 'parent_id';
/*
* Is-customer-notified flag.
*/
const IS_CUSTOMER_NOTIFIED = 'is_customer_notified';
/*
* Is-visible-on-storefront flag.
*/
const IS_VISIBLE_ON_FRONT = 'is_visible_on_front';
/*
* Comment.
*/
const COMMENT = 'comment';
/*
* Created-at timestamp.
*/
const CREATED_AT = 'created_at';
/**
* Gets the credit memo comment.
*
* @return string Comment.
*/
public function getComment();
/**
* Gets the credit memo created-at timestamp.
*
* @return string|null Created-at timestamp.
*/
public function getCreatedAt();
/**
* Sets the credit memo created-at timestamp.
*
* @param string $createdAt timestamp
* @return $this
*/
public function setCreatedAt($createdAt);
/**
* Gets the credit memo ID.
*
* @return int|null Credit memo ID.
*/
public function getEntityId();
/**
* Sets entity ID.
*
* @param int $entityId
* @return $this
*/
public function setEntityId($entityId);
/**
* Gets the is-customer-notified flag value for the credit memo.
*
* @return int Is-customer-notified flag value.
*/
public function getIsCustomerNotified();
/**
* Gets the is-visible-on-storefront flag value for the credit memo.
*
* @return int Is-visible-on-storefront flag value.
*/
public function getIsVisibleOnFront();
/**
* Gets the parent ID for the credit memo.
*
* @return int Parent ID.
*/
public function getParentId();
/**
* Sets the parent ID for the credit memo.
*
* @param int $id
* @return $this
*/
public function setParentId($id);
/**
* Sets the is-customer-notified flag value for the credit memo.
*
* @param int $isCustomerNotified
* @return $this
*/
public function setIsCustomerNotified($isCustomerNotified);
/**
* Sets the is-visible-on-storefront flag value for the credit memo.
*
* @param int $isVisibleOnFront
* @return $this
*/
public function setIsVisibleOnFront($isVisibleOnFront);
/**
* Sets the credit memo comment.
*
* @param string $comment
* @return $this
*/
public function setComment($comment);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(
\Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface $extensionAttributes
);
}