01: /*******************************************************************************
02: * Copyright (c) 2004, 2005 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.ui.wizards;
11:
12: /**
13: * A registry describing all wizard extensions known to the workbench.
14: * <p>
15: * This interface is not intended to be implemented by clients.
16: * </p>
17: *
18: * @since 3.1
19: */
20: public interface IWizardRegistry {
21:
22: /**
23: * Find a wizard with the given id.
24: *
25: * @param id the id to search for
26: * @return the wizard descriptor matching the given id or <code>null</code>
27: */
28: IWizardDescriptor findWizard(String id);
29:
30: /**
31: * Return the wizards that have been designated as "primary".
32: *
33: * @return the primary wizard descriptors. Never <code>null</code>.
34: */
35: IWizardDescriptor[] getPrimaryWizards();
36:
37: /**
38: * Find the category with the given id.
39: *
40: * @param id the id of the category to search for
41: * @return the category matching the given id or <code>null</code>
42: */
43: IWizardCategory findCategory(String id);
44:
45: /**
46: * Return the root category.
47: *
48: * @return the root category. Never <code>null</code>.
49: */
50: IWizardCategory getRootCategory();
51: }
|