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 

<?php

/* --------------------------------------------------------------
   InfoBoxServiceInterface.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 InfoBoxServiceInterface
 *
 * @category   System
 * @package    InfoBox
 * @subpackage Interfaces
 */
interface InfoBoxServiceInterface
{
    /**
     * Returns all info box messages.
     *
     * @return InfoBoxMessageCollection
     */
    public function getAllMessages();
    
    
    /**
     * Adds a new info box message.
     *
     * @param InfoBoxMessage $message Message to save.
     */
    public function addMessage(InfoBoxMessage $message);
    

    /**
     * Reactivates the messages.
     */
    public function reactivateMessages();
    
    
    /**
     * Deletes a message based on the source.
     *
     * @param StringType $source Message source.
     */
    public function deleteMessageBySource(StringType $source);
    
    
    /**
     * Deletes a message based on its identifier.
     *
     * @param StringType $identifier Message identifier.
     */
    public function deleteMessageByIdentifier(StringType $identifier);
    
    
    /**
     * Deletes a message by its ID.
     *
     * @param IdType $id Message ID.
     */
    public function deleteMessageById(IdType $id);
    
    
    /**
     * Updates a message status.
     *
     * @param IdType     $id     Message ID.
     * @param StringType $status Message status.
     */
    public function setMessageStatus(IdType $id, StringType $status);
}