IActivityRequirementBinding


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  
12  package org.eclipse.ui.activities;
13  
14  /**
15   * An instance of this interface represents a binding between two activities.
16   * The relationship can be interpreted as 'activity needs requiredActivity to 
17   * be enabled'.
18   * Enablement of the activity requires enablement of the required activity. 
19   * 
20   * <p>
21   * This interface is not intended to be extended or implemented by clients.
22   * </p>
23   * 
24   * @since 3.0
25   * @see IActivity
26   */
27  public interface IActivityRequirementBinding extends Comparable   {
28  
29      /**
30       * Returns the identifier of the activity represented in this
31       * binding. 
32       * 
33       * @return the identifier of the activity represented in this
34       *         binding. Guaranteed not to be <code>null</code>.
35       */
36      String   getActivityId();
37  
38      /**
39       * Returns the identifier of the required activity represented in this
40       * binding.  The enablement of the activity described by {@link #getActivityId()}
41       * requires the enablement of this activity.
42       * 
43       * @return the identifier of the required activity represented in this
44       *         binding. Guaranteed not to be <code>null</code>.
45       */
46      String   getRequiredActivityId();
47  }
48

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags