KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.io.Serializable JavaDoc;
14
15 import org.eclipse.core.runtime.CoreException;
16 import org.eclipse.core.runtime.IAdaptable;
17 import org.eclipse.pde.core.IWritable;
18
19 /**
20  * A base of all site model objects.
21  */

22 public interface ISiteObject extends IWritable, IAdaptable, Serializable JavaDoc {
23     /**
24      * A property name that will be used to notify about changes in the "label"
25      * field.
26      */

27     String JavaDoc P_LABEL = "label"; //$NON-NLS-1$
28

29     /**
30      * Returns the top-level site model object.
31      *
32      * @return root feature object
33      */

34     public ISite getSite();
35
36     /**
37      * Returns the label of this feature model object'
38      *
39      * @return feature object label
40      */

41     String JavaDoc getLabel();
42
43     /**
44      * Returns the site model that owns this model object.
45      *
46      * @return the site model
47      */

48     ISiteModel getModel();
49
50     boolean isInTheModel();
51
52     /**
53      * Returns the parent of this model object.
54      *
55      * @return the model object parent
56      */

57     public ISiteObject getParent();
58
59     /**
60      * Sets the new label of this model object. This method may throw a
61      * CoreException if the model is not editable.
62      *
63      * @param label
64      * the new label
65      */

66     void setLabel(String JavaDoc label) throws CoreException;
67
68     /**
69      * Returns true if this object as all the required attributes set, false
70      * otherwise.
71      */

72     boolean isValid();
73 }
74
Popular Tags