KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > ixenon > free > nodes > Installable


1 /* $Id$
2  *
3  * Copyright (c) 1999 Xenonsoft Limited. All Rights Reserved.
4  *
5  * This software is protected by copyright. You are hereby notified from
6  * now by reading this message. This software is also the confidential
7  * and proprietary information of Xenonsoft Limited. ("Confidential
8  * Information").
9  *
10  * This software is distributed under the Xenonsoft Public end user
11  * License ("XPeL"), where the machine-readable source code is provided
12  * under the "Open Source" model.
13  * For more information, please read the file "LICENSE-XPL.txt"
14  */

15
16 //
17
// DESCRIPTION
18
//
19
// Peter Pilgrim
20
// Sun Jan 17 19:28:41 GMT 1999
21
//
22
// RCS HEADER ``Installable''
23
//
24
// $Author$
25
// $Date$
26
// $Source$
27
// $Revision$ $State$ $Locker$
28
//
29

30 package ixenon.free.nodes;
31
32 import java.awt.*;
33 import java.awt.event.*;
34 import java.util.*;
35
36 import ixenon.free.install.*; // for FreeInstallerApplication
37
import ixenon.free.uninstall.*; // for Uninstallable
38

39
40 /**
41  * An interface for any object installable that knows how
42  * to install an entity on a customer's system.
43  */

44 public interface Installable {
45
46     /** Gets the name of the installable */
47     public String JavaDoc getNodeName();
48     
49     /** Sets the name of the installable */
50     public void setNodeName( String JavaDoc newNodeName );
51     
52     /**
53      * Is this Compulsory installable whose visual component is one
54      * that must be viewed or not.
55      * @see getVisualComponent
56      */

57     public abstract boolean isCompulsoryView();
58     
59     /**
60      * sets the locale
61      */

62     public abstract void setLocale( Locale locale );
63
64     /**
65      * set the installation mode type
66      * @see InstallConstants
67      */

68     public abstract void setInstallMode( int installMode );
69
70     /**
71      * create or retrieve the visual component of the installable
72      * if one exists. Otherwise return null.
73      */

74     public abstract Component getVisualComponent();
75     
76     /**
77      * create or retrieve the configurable component of the installable
78      * if one exists. Otherwise return null object.
79      */

80     public abstract Component getConfigurableComponent();
81
82     /**
83      * method to perform the installation of content
84      *
85      * @exception <code>InstallException</code> if there is an
86      * problem trying to install the entity.
87      */

88     public abstract void install() throws InstallException;
89
90     /**
91      * method to set the <code>Uninstallable</code> content.
92      * @param uninst the <code>Uninstallable</code> object that knows
93      * how to write a stub or script to uninstall the files.
94      */

95     public abstract void setUninstaller( Uninstallable uninst );
96     
97     /**
98      * method to perform the cleanup of content if cancelled, or aborted
99      */

100     public abstract void cleanup() throws InstallException;
101 }
102
103 // fini
104
Popular Tags