KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sapia > magnet > domain > LaunchHandlerIF


1 package org.sapia.magnet.domain;
2
3 // Import of Sun's JDK classes
4 // ---------------------------
5 import java.util.Collection JavaDoc;
6
7 // Import of Sapia's magnet classes
8 // --------------------------------
9 import org.sapia.magnet.render.RenderableIF;
10
11
12 /**
13  *
14  *
15  * @author Jean-Cedric Desrochers
16  *
17  * <dl>
18  * <dt><b>Copyright:</b><dd>Copyright &#169; 2002-2003 <a HREF="http://www.sapia-oss.org">Sapia Open Source Software</a>. All Rights Reserved.</dd></dt>
19  * <dt><b>License:</b><dd>Read the license.txt file of the jar or visit the
20  * <a HREF="http://www.sapia-oss.org/license.html" target="sapia-license">license page</a> at the Sapia OSS web site</dd></dt>
21  * </dl>
22  */
23 public interface LaunchHandlerIF extends RenderableIF {
24
25   /**
26    * Returns the type of this launcher.
27    *
28    * @return The type of this launcher.
29    */
30   public String JavaDoc getType();
31
32
33   /**
34    * Returns the name of this launcher.
35    *
36    * @return The name of this launcher.
37    */
38   public String JavaDoc getName();
39
40
41   /**
42    * Returns the default profile name of this launcher.
43    *
44    * @return The default profile name of this launcher.
45    */
46   public String JavaDoc getDefault();
47
48
49   /**
50    * Returns the number of milliseoncds to wait after executing this launcher.
51    *
52    * @return the number of milliseoncds to wait after executing this launcher.
53    */
54   public int geWaitTime();
55
56
57   /**
58    * Returns the parent magnet of this launch handler.
59    *
60    * @return The parent magnet of this launch handler.
61    */
62   public Magnet getMagnet();
63
64
65   /**
66    * Returns the collection of profiles of this launcher.
67    *
68    * @return The collection of <CODE>Profile</CODE> objects of this launcher.
69    */
70   public Collection JavaDoc getProfiles();
71
72
73   /**
74    * Returns the profile for the profile name passed in.
75    *
76    * @param aProfileName The name of the profile.
77    * @return The profile for the profile name passed in.
78    */
79   public Profile getProfile(String JavaDoc aProfileName);
80
81
82   /**
83    * Changes the type of this launcher handler.
84    *
85    * @param aType The new type.
86    */
87   public void setType(String JavaDoc aType);
88
89
90   /**
91    * Changes the name of this launcher handler.
92    *
93    * @param aName The new name.
94    */
95   public void setName(String JavaDoc aName);
96
97
98   /**
99    * Changes the default profile name of this launcher handler.
100    *
101    * @param aProfileName The new default profile name.
102    */
103   public void setDefault(String JavaDoc aProfileName);
104
105
106   /**
107    * Changes the value of the time to wait after executing this launcher.
108    *
109    * @param aWaitTime The new wait time value in milliseconds.
110    */
111   public void setWaitTime(int aWaitTime);
112
113
114   /**
115    * Changes the parent magnet of this launch handler.
116    *
117    * @param aMagnet the new Magnet.
118    */
119   public void setMagnet(Magnet aMagnet);
120
121
122   /**
123    * Adds the profile passed in to this launch handler.
124    *
125    * @param aProfile The profile to add.
126    */
127   public void addProfile(Profile aProfile);
128
129
130   /**
131    * Executes this launch handler for the passed in profile.
132    *
133    * @param aProfile The profile to execute.
134    */
135   public void execute(String JavaDoc aProfile);
136 }
137
Popular Tags