plugins/org.eclipse.bpmn2.modeler.core/src/org/eclipse/bpmn2/modeler/core/features/IFeatureContainer.java

/*******************************************************************************
 * Copyright (c) 2011, 2012, 2013 Red Hat, Inc.
 * All rights reserved.
 * This program is 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:
 * 	Red Hat, Inc. - initial API and implementation
 ******************************************************************************/
package org.eclipse.bpmn2.modeler.core.features;

import org.eclipse.graphiti.features.IAddFeature;
import org.eclipse.graphiti.features.IDeleteFeature;
import org.eclipse.graphiti.features.IDirectEditingFeature;
import org.eclipse.graphiti.features.IFeatureProvider;
import org.eclipse.graphiti.features.ILayoutFeature;
import org.eclipse.graphiti.features.IRemoveFeature;
import org.eclipse.graphiti.features.IUpdateFeature;
import org.eclipse.graphiti.features.context.IContext;
import org.eclipse.graphiti.features.custom.ICustomFeature;

// TODO: Auto-generated Javadoc
/**
 * The Interface IFeatureContainer.
 */
public interface IFeatureContainer {
	
	/**
	 * Checks if any of the Features provided by this Feature Container are available.
	 *
	 * @param fp the fp
	 * @return true, if is available
	 */
	boolean isAvailable(IFeatureProvider fp);
	
	/**
	 * Gets the Business Object on which the Feature operates. The Feature
	 * Container must extract the correct Business Object from the IContext.
	 *
	 * @param context the context
	 * @return the apply object
	 */
	Object getApplyObject(IContext context);
	
	/**
	 * Checks if the given Business Object is applicable to the Features
	 * provided by the Feature Container.
	 *
	 * @param o the o
	 * @return true, if successful
	 */
	boolean canApplyTo(Object o);
	
	/**
	 * Gets the add feature.
	 *
	 * @param fp the Feature Provider
	 * @return the add feature
	 */
	IAddFeature getAddFeature(IFeatureProvider fp);
	
	/**
	 * Gets the update feature.
	 *
	 * @param fp the Feature Provider
	 * @return the update feature
	 */
	IUpdateFeature getUpdateFeature(IFeatureProvider fp);
	
	/**
	 * Gets the direct editing feature.
	 *
	 * @param fp the Feature Provider
	 * @return the direct editing feature
	 */
	IDirectEditingFeature getDirectEditingFeature(IFeatureProvider fp);
	
	/**
	 * Gets the layout feature.
	 *
	 * @param fp the Feature Provider
	 * @return the layout feature
	 */
	ILayoutFeature getLayoutFeature(IFeatureProvider fp);
	
	/**
	 * Gets the remove feature.
	 *
	 * @param fp the Feature Provider
	 * @return the removes the feature
	 */
	IRemoveFeature getRemoveFeature(IFeatureProvider fp);
	
	/**
	 * Gets the delete feature.
	 *
	 * @param fp the Feature Provider
	 * @return the delete feature
	 */
	IDeleteFeature getDeleteFeature(IFeatureProvider fp);
	
	/**
	 * Gets the custom features.
	 *
	 * @param fp the Feature Provider
	 * @return the custom features
	 */
	ICustomFeature[] getCustomFeatures(IFeatureProvider fp);

}