Revision 24975 branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/resource/ResourceNotification.java

View differences:

ResourceNotification.java
32 32

  
33 33

  
34 34
/**
35
 * A resource notification is related to a change in the state of a resource.
36
 * It is sent to all resource observers when appropriate. The notification contains
37
 * the type of change and access to the resource information.
38
 * 
39
 * This includes:
40
 * 
41
 * <ul>
42
 * 	<li>A resource has been opened</li>
43
 *  <li>A resource has been closed</li>
44
 *  <li>A resource has been prepared</li>
45
 *  <li>A resource property has been changed</li>
46
 *  <li>A resource is being disposed</li>
47
 *  <li>A resource is being opened</li>
48
 *  <li>A resource is being closed</li>
49
 * </ul>	
50
 * 
35 51
 * @author jmvivo
36
 *
37 52
 */
38 53
public interface ResourceNotification {
39 54

  
55
	/** A resource has been opened */
40 56
	public static final String OPENED = "Opened_Resource";
57
	/** A resource has been closed */
41 58
	public static final String CLOSED = "Closed_Resource";
59
	/** A resource has been prepared */
42 60
	public static final String PREPARE = "Prepare_Resource";
61
	/** A resource property has been changed */
43 62
	public static final String CHANGED = "Changed_Resource";
63
	/** A resource is being disposed */
44 64
	public static final String DISPOSE = "Begin_Dispose_Resource";
65
	/** A resource is being opened */
45 66
	public static final String OPEN = "Begin_Open_Resource";
67
	/** A resource is being closed */
46 68
	public static final String CLOSE = "Begin_Close_Resource";
47 69

  
70
	/**
71
	 * Returns the parameters of the resource that caused
72
	 * this notification.
73
	 * 
74
	 * @return
75
	 * 		the parameters of this notification's source
76
	 */
48 77
	public ResourceParameters getParameters();
78
	
79
	/**
80
	 * Returns the resource that caused this notification.
81
	 * 
82
	 * @return
83
	 * 		this notification's source
84
	 */
49 85
	public Resource getResource();
86
	
87
	/**
88
	 * Returns the type of this notification.
89
	 * 
90
	 * @return
91
	 * 		this notification's type. For the allowed values see the 
92
	 * constants defined in this interface.
93
	 */
50 94
	public String getType();
51 95

  
52 96
}

Also available in: Unified diff