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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
<?php
/* --------------------------------------------------------------
InfoBoxMessageInterface.php 2016-08-26
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface InfoBoxMessageInterface
*
* @category System
* @package InfoBox
* @subpackage Interfaces
*/
interface InfoBoxMessageInterface
{
/**
* Sets the message's source.
*
* @param StringType $source Source of the message (e.g. 'internal').
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setSource(StringType $source);
/**
* Returns the message's source.
*
* @return string Source of the message.
*/
public function getSource();
/**
* Sets the ID of the message.
*
* @param IdType $id Identifier of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setId(IdType $id);
/**
* Returns the ID of the message.
*
* @return int ID of the message.
*/
public function getId();
/**
* Sets the identifier string of the message
*
* @param StringType $identifier Message identifier.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setIdentifier(StringType $identifier);
/**
* Returns the message identifier.
*
* @return string Message identifier.
*/
public function getIdentifier();
/**
* Sets the status of the message.
*
* @param StringType $status Status of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setStatus(StringType $status);
/**
* Returns the status of the message.
*
* @return string Status of the message.
*/
public function getStatus();
/**
* Sets the type of the message.
*
* @param StringType $type Type of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setType(StringType $type);
/**
* Returns the type of the message.
*
* @return string
*/
public function getType();
/**
* Sets the visibility of the message.
*
* @param StringType $visibility Visibility of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setVisibility(StringType $visibility);
/**
* Returns the visibility of the message.
*
* @return string Visibility of the message.
*/
public function getVisibility();
/**
* Sets the link of the message button.
*
* @param StringType $buttonLink Link of the message button.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setButtonLink(StringType $buttonLink);
/**
* Returns the link of the message button.
*
* @return string Link of the message button.
*/
public function getButtonLink();
/**
* Sets the customer ID of the message.
*
* @param IdType $customerId Customer ID of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setCustomerId(IdType $customerId);
/**
* Returns the customer ID of the message.
*
* @return int
*/
public function getCustomerId();
/**
* Sets the message creation date time.
*
* @param DateTime $dateTime Message added date time value.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setAddedDateTime(DateTime $dateTime);
/**
* Returns the message creation date time.
*
* @return DateTime The added date time.
*/
public function getAddedDateTime();
/**
* Sets the message modification date time.
*
* @param DateTime $dateTime Message modification date time.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setModifiedDateTime(DateTime $dateTime);
/**
* Returns the message modification date time.
*
* @return DateTime The modified date time.
*/
public function getModifiedDateTime();
/**
* Sets the message headline.
*
* @param StringType $text Message headline.
* @param LanguageCode $languageCode Language code for message headline.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setHeadLine(StringType $text, LanguageCode $languageCode);
/**
* Returns the message headline.
*
* @param LanguageCode $languageCode Language code of the message headline.
*
* @return string The message headline.
*/
public function getHeadLine(LanguageCode $languageCode);
/**
* Sets the message.
*
* @param StringType $text Message.
* @param LanguageCode $languageCode Language code of the message.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setMessage(StringType $text, LanguageCode $languageCode);
/**
* Returns the message.
*
* @param LanguageCode $languageCode Language code of the message.
*
* @return string The message.
*/
public function getMessage(LanguageCode $languageCode);
/**
* Sets the message button label.
*
* @param StringType $text Button label text.
* @param LanguageCode $languageCode Button label text language code.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setButtonLabel(StringType $text, LanguageCode $languageCode);
/**
* Returns the message button label.
*
* @param LanguageCode $languageCode Button label language code.
*
* @return string The message button label.
*/
public function getButtonLabel(LanguageCode $languageCode);
/**
* Sets the messages by adding a collection.
*
* @param KeyValueCollection $messages Messages.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setMessageCollection(KeyValueCollection $messages);
/**
* Sets the message headlines.
*
* @param KeyValueCollection $headlines Message headlines.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setHeadLineCollection(KeyValueCollection $headlines);
/**
* Sets the button labels.
*
* @param KeyValueCollection $buttonLabels Message button labels.
*
* @return InfoBoxMessageInterface Same instance for method chaining.
*/
public function setButtonLabelCollection(KeyValueCollection $buttonLabels);
/**
* Returns the message collection.
*
* @return EditableKeyValueCollection
*/
public function getMessageCollection();
/**
* Returns the headline collection.
*
* @return EditableKeyValueCollection
*/
public function getHeadLineCollection();
/**
* Returns the button label collection.
*
* @return EditableKeyValueCollection
*/
public function getButtonLabelCollection();
}