View Javadoc

1   package cz.cuni.amis.pogamut.multi.communication.translator.event;
2   
3   import cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent;
4   import cz.cuni.amis.pogamut.base.communication.worldview.object.WorldObjectId;
5   
6   /**
7    * Interface for all compositeObject updates in the world.
8    * Composite updates return no result by themselves, only the partial updates do.
9    * @author srlok
10   *
11   */
12  public interface ICompositeWorldObjectUpdatedEvent extends IWorldChangeEvent {
13  	
14  	/**
15  	 * Returns WorldObjectId of the updatedObject.
16  	 * @return
17  	 */
18  	public WorldObjectId getId();
19  
20  	/**
21  	 * Returns the event updating the local part of the object.
22  	 * @return
23  	 */
24  	public ILocalWorldObjectUpdatedEvent getLocalEvent();
25  	
26  	/**
27  	 * Returns the event updating the shared part of the object.
28  	 * @return
29  	 */
30  	public ISharedWorldObjectUpdatedEvent getSharedEvent();
31  	
32  	/**
33  	 * Returns the update related to the static part of the object.
34  	 * Static updates are only possible if they create or destroy the object. (Updating the static part doesnt even make sense,
35  	 * the static part stays the same from definition.) 
36  	 * If the event does not create/destroy the static object part, this should return null.
37  	 * @return
38  	 */
39  	public IStaticWorldObjectUpdatedEvent getStaticEvent(); //we need this for CREATED and DESTROYED events
40  
41  	
42  }