01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.pde.internal.core.isite;
11:
12: import org.eclipse.pde.core.IModel;
13: import org.eclipse.pde.core.IModelChangeProvider;
14:
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: /**
28: * Returns the factory that should be used
29: * to create new instances of model objects.
30: *
31: * @return feature model factory
32: */
33: ISiteModelFactory getFactory();
34:
35: /**
36: * Returns install location of the site.xml file in case of external files.
37: *
38: * @return install location for external files,
39: * or <samp>null</samp> for models based on
40: * workspace resources.
41: */
42: public String getInstallLocation();
43:
44: /**
45: * Tests whether this model is enabled.
46: *
47: * @return <samp>true</samp> if the model is enabled
48: */
49: public boolean isEnabled();
50:
51: /**
52: * Enables or disables this model.
53: *
54: * @param enabled the new enable state
55: */
56: public void setEnabled(boolean enabled);
57: }
|