KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > isite > ISiteModel


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.pde.internal.core.isite;
12
13 import org.eclipse.pde.core.IModel;
14 import org.eclipse.pde.core.IModelChangeProvider;
15 /**
16  * This model type is designed to hold data loaded from
17  * "site.xml" file of an Eclipse update site.
18  */
19 public interface ISiteModel extends IModel, IModelChangeProvider {
20 /**
21  * Returns the top-level model object.
22  *
23  * @return top-level model object of the site model
24  */
25 public ISite getSite();
26 /**
27  * Returns the factory that should be used
28  * to create new instances of model objects.
29  *
30  * @return feature model factory
31  */
32 ISiteModelFactory getFactory();
33 /**
34  * Returns install location of the site.xml file in case of external files.
35  *
36  * @return install location for external files,
37  * or <samp>null</samp> for models based on
38  * workspace resources.
39  */
40 public String JavaDoc getInstallLocation();
41 /**
42  * Tests whether this model is enabled.
43  *
44  * @return <samp>true</samp> if the model is enabled
45  */
46 public boolean isEnabled();
47 /**
48  * Enables or disables this model.
49  *
50  * @param enabled the new enable state
51  */
52 public void setEnabled(boolean enabled);
53 }
54
Popular Tags