001/*
002 * GWTEventService
003 * Copyright (c) 2011 and beyond, strawbill UG (haftungsbeschr?nkt)
004 *
005 * This is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU Lesser General Public License as
007 * published by the Free Software Foundation; either version 3 of
008 * the License, or (at your option) any later version.
009 * Other licensing for GWTEventService may also be possible on request.
010 * Please view the license.txt of the project for more information.
011 *
012 * This software is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this software; if not, write to the Free
019 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021 */
022package de.novanic.eventservice.client.event;
023
024import de.novanic.eventservice.client.event.domain.Domain;
025
026import java.io.Serializable;
027
028/**
029 * A {@link de.novanic.eventservice.client.event.DomainEvent} is a container and contains an event and the domain where the event has occurred.
030 *
031 * @author sstrohschein
032 *         <br>Date: 05.10.2008
033 *         <br>Time: 15:17:40
034 */
035public interface DomainEvent extends Serializable
036{
037    /**
038     * An event/DomainEvent is user specific when it is only for one user and not for the complete domain.
039     * This flag depends on the constructor. If the DomainEvent is created with a domain, the DomainEvent isn't user
040     * specific.
041     * @return true when the event is user specific, otherwise false
042     */
043    boolean isUserSpecific();
044
045    /**
046     * Returns the event.
047     * @return event
048     */
049    Event getEvent();
050
051    /**
052     * Returns the domain where the event has occurred.
053     * @return domain
054     */
055    Domain getDomain();
056}