package votorola.s.gwt.scene.feed;  // Copyright 2010-2012, Michael Allan. Christian Weilbach. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import java.util.Date;
import votorola.a.count.Poll;
import votorola.a.diff.DiffLook;
import votorola.s.gwt.stage.Message;


/** A real-world event as formalized in a bite feed.  It provides accessors for all
  * possible properties, although only a subset is likely to be backed by actual values in
  * particular instances.  Which properties are backed and which are unbacked will vary
  * according to the feed from which the bite has issued.  The API docs for the various
  * accessors will specify the behaviour to expect for unbacked properties.
  */
public interface Bite
{


    /** The difference associated with this bite.
      *
      *     @return the difference, or null if none is associated with this bite.
      */
    public DiffLook difference();



    /** The first message associated with this bite.
      *
      *     @return the first message, or null if none is associated with this bite.
      */
    public Message message();



    /** All messages associated with this bite.
      *
      *     @return a collection of messages, the form of the collection depending on the
      *       implementation.
      */
    public Object messages();



    /** The date on which the bite was parsed into the database.
      *
      *     @return the date, or null if none is associated with this bite.
      */
    public Date sentDate();



    /** The first person associated with this bite.
      *
      *     @return the first person, or null if nobody is associated with this bite.
      */
    public Person person();



    /** All persons associated with this bite.
      *
      *     @return a collection of persons, the form of the collection depending on the
      *       implementation.
      */
    public Object persons();



    /** The poll associated with this bite.
      *
      *     @return the poll, or null if none is associated with this bite.
      */
    public Poll poll();


}