Revision 20098 trunk/libraries/libRemoteServices/src/org/gvsig/remoteClient/wms/ICancellable.java

View differences:

ICancellable.java
49 49
 *
50 50
 */
51 51
package org.gvsig.remoteClient.wms;
52

  
52 53
/**
53
 * <p>When a task is accessing to remote data, takes an indeterminate time, and some times gets locked. This
54
 * is the reason which this kind of task can be canceled.</p>
55
 * <p>The <code>ICancellable</code> interface is designed for get information about the cancellation of a
56
 * task related to the download of remote information.</p>
54
 * <p>When a task is accessing to remote data, takes an indeterminate time, and occasionally gets locked. That's
55
 * the reason a task should support to be cancelable.</p>
56
 * <p><code>ICancellable</code> interface is designed for getting information about the cancellation of a
57
 * task of downloading remote information.</p>
57 58
 */
58 59
public interface ICancellable {
59 60
	/**
60
	 * <p>Returns <code>true</code> if a download or a group of downloads has been canceled.</p>
61
	 *
62
	 * @return <code>true</code> if a download or a group of downloads has been canceled, otherwise <code>false</code>
61
	 * <p>Returns <code>true</code> if a download or a group of downloads tasks has been canceled.</p>
62
	 * 
63
	 * @return <code>true</code> if a download or a group of downloads tasks has been canceled, otherwise <code>false</code>
63 64
	 */
64 65
	public boolean isCanceled();
65

  
66
	
66 67
	/**
67
	 * This method is used to cancel only a group of
68
	 * downloads with the same identifier
69
	 * @return The identifier
68
	 * <p>Used to cancel only a group of downloads tasks with the same identifier.</p>
69
	 * 
70
	 * @return the identifier
70 71
	 */
71 72
	public Object getID();
72 73
}

Also available in: Unified diff