KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > ischema > ISchemaObject


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.ischema;
12
13 import org.eclipse.core.runtime.IAdaptable;
14 import org.eclipse.pde.core.IWritable;
15 /**
16  * Base interface for all objects that belong to the extension point
17  * schema model.
18  */

19 public interface ISchemaObject extends IAdaptable, IWritable {
20 /**
21  * Property constant that will be used in the model change event
22  * when description field of this object changes.
23  */

24 public static final String JavaDoc P_DESCRIPTION="description"; //$NON-NLS-1$
25
/**
26  * Property constant that will be used in the model change event
27  * when "name" field of this object changes.
28  */

29 public static final String JavaDoc P_NAME = "name"; //$NON-NLS-1$
30
/**
31  * Returns text associated with this schema object. Typically, it is
32  * annotation that will be used to compose the reference HTML documentation.
33  * The text may contain HTML tags.
34  */

35 public String JavaDoc getDescription();
36 /**
37  * Returns the presentation name of this schema object.
38  */

39 public String JavaDoc getName();
40 /**
41  * Returns the parent of this schema object.
42  */

43 ISchemaObject getParent();
44
45 void setParent(ISchemaObject parent);
46 /**
47  * Returns the schema object to which this object belongs.
48  */

49 public ISchema getSchema();
50 }
51
Popular Tags