1: <?php
  2: /**
  3:  * Defines the event interface required for iTip-Handling / resource booking.
  4:  *
  5:  * PHP version 5
  6:  *
  7:  * @category Horde
  8:  * @package  Itip
  9:  * @author   Gunnar Wrobel <wrobel@pardus.de>
 10:  * @license  http://www.horde.org/licenses/lgpl21 LGPL
 11:  * @link     http://pear.horde.org/index.php?package=Itip
 12:  */
 13: 
 14: /**
 15:  * Defines the event interface required for iTip-Handling / resource booking.
 16:  *
 17:  * Copyright 2010 Klarälvdalens Datakonsult AB
 18:  * Copyright 2010-2012 Horde LLC (http://www.horde.org/)
 19:  *
 20:  * See the enclosed file COPYING for license information (LGPL). If you did not
 21:  * receive this file, see
 22:  * {@link http://www.horde.org/licenses/lgpl21 LGPL}.
 23:  *
 24:  * @category Horde
 25:  * @package  Itip
 26:  * @author   Gunnar Wrobel <wrobel@pardus.de>
 27:  * @license  http://www.horde.org/licenses/lgpl21 LGPL
 28:  * @link     http://pear.horde.org/index.php?package=Itip
 29:  */
 30: interface Horde_Itip_Event
 31: {
 32:     /**
 33:      * Returns the event as vEvent.
 34:      *
 35:      * @return Horde_Icalendar_Vevent The wrapped event.
 36:      */
 37:     public function getVevent();
 38: 
 39:     /**
 40:      * Return the method of the iTip request.
 41:      *
 42:      * @return string The method of the request.
 43:      */
 44:     public function getMethod();
 45: 
 46:     /**
 47:      * Return the uid of the iTip event.
 48:      *
 49:      * @return string The uid of the event.
 50:      */
 51:     public function getUid();
 52: 
 53:     /**
 54:      * Return the summary for the event.
 55:      *
 56:      * @return string The summary.
 57:      */
 58:     public function getSummary();
 59: 
 60:     /**
 61:      * Return the start of the iTip event.
 62:      *
 63:      * @return string The start of the event.
 64:      */
 65:     public function getStart();
 66: 
 67:     /**
 68:      * Return the end of the iTip event.
 69:      *
 70:      * @return string The end of the event.
 71:      */
 72:     public function getEnd();
 73: 
 74:     /**
 75:      * Return the organizer of the iTip event.
 76:      *
 77:      * @return string The organizer of the event.
 78:      */
 79:     public function getOrganizer();
 80: 
 81:     /**
 82:      * Copy the details from an event into this one.
 83:      *
 84:      * @param Horde_Itip_Event $event The event to copy from.
 85:      *
 86:      * @return NULL
 87:      */
 88:     public function copyEventInto(Horde_Itip_Event $event);
 89: 
 90:     /**
 91:      * Set the attendee parameters.
 92:      *
 93:      * @param string $attendee    The mail address of the attendee.
 94:      * @param string $common_name Common name of the attendee.
 95:      * @param string $status      Attendee status (ACCPETED, DECLINED, TENTATIVE)
 96:      *
 97:      * @return NULL
 98:      */
 99:     public function setAttendee($attendee, $common_name, $status);
100: }