IActivity


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.update.configuration;
12  
13  import java.util.Date  ;
14  
15  import org.eclipse.core.runtime.*;
16  
17  /**
18   * Install activity.
19   * Represents a record of an installation action performed
20   * on a particular installation configuration.
21   * <p>
22   * This interface is not intended to be implemented by clients.
23   * </p>
24   * <p>
25   * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
26   * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
27   * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
28   * (repeatedly) as the API evolves.
29   * </p>
30   * @see org.eclipse.update.configuration.IInstallConfiguration
31   * @since 2.0
32   */
33  public interface IActivity extends IAdaptable {
34  
35      /**
36       * Indicates feature installation action
37       * 
38       * @since 2.0
39       * <p>
40       * <b>Note:</b> This field is part of an interim API that is still under development and expected to
41       * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
42       * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
43       * (repeatedly) as the API evolves.
44       * </p>
45       */
46      public static final int ACTION_FEATURE_INSTALL = 1;
47  
48      /**
49       * Indicates feature removal (uninstallation) action
50       * 
51       * @since 2.0
52       * <p>
53       * <b>Note:</b> This field is part of an interim API that is still under development and expected to
54       * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
55       * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
56       * (repeatedly) as the API evolves.
57       * </p>
58       */
59      public static final int ACTION_FEATURE_REMOVE = 2;
60  
61      /**
62       * Indicates an addition of a site to a configuration
63       * 
64       * @since 2.0
65       * <p>
66       * <b>Note:</b> This field is part of an interim API that is still under development and expected to
67       * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
68       * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
69       * (repeatedly) as the API evolves.
70       * </p>
71       */
72      public static final int ACTION_SITE_INSTALL = 3;
73  
74      /**
75       * Indicates removal of a site from a configuration
76       * 
77       * @since 2.0
78       * <p>
79       * <b>Note:</b> This field is part of an interim API that is still under development and expected to
80       * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
81       * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
82       * (repeatedly) as the API evolves.
83       * </p>
84       */
85      public static final int ACTION_SITE_REMOVE = 4;
86  
87      /**
88       * Indicates feature unconfiguration action
89       * 
90       * @since 2.0
91       * <p>
92       * <b>Note:</b> This field is part of an interim API that is still under development and expected to
93       * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
94       * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
95       * (repeatedly) as the API evolves.
96       * </p>
97       */
98      public static final int ACTION_UNCONFIGURE = 5;
99  
100     /**
101      * Indicates feature configuration action
102      * 
103      * @since 2.0
104      * <p>
105      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
106      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
107      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
108      * (repeatedly) as the API evolves.
109      * </p>
110      */
111     public static final int ACTION_CONFIGURE = 6;
112 
113     /**
114      * Indicates reverting to a prior configuration state
115      * 
116      * @since 2.0
117      * <p>
118      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
119      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
120      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
121      * (repeatedly) as the API evolves.
122      * </p>
123      */
124     public static final int ACTION_REVERT = 7;
125 
126     /**
127      * Indicates reconcilliation with changes made directly to the site
128      * installation directory
129      * 
130      * @since 2.0
131      * <p>
132      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
133      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
134      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
135      * (repeatedly) as the API evolves.
136      * </p>
137      */
138     public static final int ACTION_RECONCILIATION = 8;
139 
140     /**
141      * Indicates adding the configuration to a preserved state
142      * 
143      * @since 2.0
144      * <p>
145      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
146      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
147      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
148      * (repeatedly) as the API evolves.
149      * </p>
150      */
151     public static final int ACTION_ADD_PRESERVED = 9;
152     
153     /**
154      * Indicates the action completed cussessfully
155      * 
156      * @since 2.0
157      * <p>
158      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
159      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
160      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
161      * (repeatedly) as the API evolves.
162      * </p>
163      */
164     public static final int STATUS_OK = 0;
165 
166     /**
167      * Indicates the action did not complete successfully
168      * 
169      * @since 2.0
170      * <p>
171      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
172      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
173      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
174      * (repeatedly) as the API evolves.
175      * </p>
176      */
177     public static final int STATUS_NOK = 1;
178 
179     /**
180      * Returns the action code for this activity
181      * 
182      * @see #ACTION_FEATURE_INSTALL
183      * @see #ACTION_FEATURE_REMOVE
184      * @see #ACTION_SITE_INSTALL
185      * @see #ACTION_SITE_REMOVE
186      * @see #ACTION_UNCONFIGURE
187      * @see #ACTION_CONFIGURE
188      * @see #ACTION_REVERT
189      * @see #ACTION_RECONCILIATION
190      * @return action code, as defined in this interface
191      * @since 2.0 
192      * <p>
193      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
194      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
195      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
196      * (repeatedly) as the API evolves.
197      * </p>
198      */
199     public int getAction();
200 
201     /**
202      * Returns the displayable label for this action
203      * 
204      * @return diplayable label for action
205      * @since 2.0 
206      * <p>
207      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
208      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
209      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
210      * (repeatedly) as the API evolves.
211      * </p>
212      */
213     public String   getLabel();
214 
215     /**
216      * Returns the creation date of this activity
217      * 
218      * @return activity date
219      * @since 2.0 
220      * <p>
221      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
222      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
223      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
224      * (repeatedly) as the API evolves.
225      * </p>
226      */
227     public Date   getDate();
228 
229     /** 
230      * Returns the activity completion status
231      * 
232      * @see #STATUS_OK
233      * @see #STATUS_NOK
234      * @return completion status, as defined in this interface
235      * @since 2.0 
236      * <p>
237      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
238      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
239      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
240      * (repeatedly) as the API evolves.
241      * </p>
242      */
243     public int getStatus();
244 
245     /**
246      * Returns the installation configuration that was the result of 
247      * this action
248      * 
249      * @return installation configuration
250      * @since 2.0
251      * <p>
252      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
253      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
254      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
255      * (repeatedly) as the API evolves.
256      * </p>
257      */
258     public IInstallConfiguration getInstallConfiguration();
259 }
260
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags