org.eclipse.ui.activities.IActivityRequirementBinding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui.activities;

/**
 * An instance of this interface represents a binding between two activities.
 * The relationship can be interpreted as 'activity needs requiredActivity to
 * be enabled'.
 * Enablement of the activity requires enablement of the required activity.
 *
 * 
 * This interface is not intended to be extended or implemented by clients.
 * 
 *
 * @since 3.0
 * @see IActivity
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IActivityRequirementBinding extends Comparable {

    /**
     * Returns the identifier of the activity represented in this
     * binding.
     *
     * @return the identifier of the activity represented in this
     *         binding. Guaranteed not to be null.
     */
    String getActivityId();

    /**
     * Returns the identifier of the required activity represented in this
     * binding.  The enablement of the activity described by {@link #getActivityId()}
     * requires the enablement of this activity.
     *
     * @return the identifier of the required activity represented in this
     *         binding. Guaranteed not to be null.
     */
    String getRequiredActivityId();
}