/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.ui.viewsupport;

import org.eclipse.jface.action.IMenuManager;
import org.eclipse.ui.views.properties.IPropertySource;


/** 
 * Interface which provides extended model objects that are NOT EObjects to be displayed. This is required to prevent filtering
 * via the ModelWorkspaceViewerFilter for non-EObjects
 * @since 8.0
 */
public interface IExtendedModelObject {
    
    /**
     * Required method to generically delegate the property source for contributed/extended model objects 
     * @return
     * @since 5.0
     */
    IPropertySource getPropertySource();

    /**
     * Required method to contribute a label to the Status Bar on selection. May return NULL string 
     * @return
     * @since 5.0
     */
    String getStatusLabel();
    
    
    /**
     * Required method to contribute menu items to context menu on selection of an IExtendedModelObject in Modeler Explorer 
     * @param theMenu
     * @since 5.0
     */
    void fillContextMenu(IMenuManager theMenu);
    
    /**
     * Implementers should return TRUE to utilize fillContextMenu() 
     * @return
     * @since 5.0
     */
    boolean overrideContextMenu();
}