FindTypedObjectCommand.java

/*
 * 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.core.search.commands;

import java.util.Collection;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.teiid.designer.core.index.IndexSelector;

/**
 * This interface is used to find typed objects based on datatype criteria.
 *
 * @since 8.0
 */
public interface FindTypedObjectCommand	extends SearchCommand {

	/**
	 * Return a collection of record
	 * objects that are found on this command execution. 
	 * @return a collection of records
	 */
	Collection getRecordInfo();
    
    /**
     * Set the IndexSelector that will be used to obtain models that will be searched.
     * @param selector the index selector that should be used, or null if the 
     * {@link org.teiid.designer.core.index.ModelWorkspaceIndexSelector} should be used
     */
    void setIndexSelector( IndexSelector selector );
    
    /**
     * Set the metamodel class to use in the search. 
     * @param metaClass
     * @since 4.1
     */
    public void setMetaClass(EClass metaClass);
    
    /**
     * Set the EObject representing the simple datatype that must be matched 
     * @param datatype
     * @param includeSubtypes
     * @since 4.1
     */
    public void setDatatype( EObject datatype );
    
    /**
     * Set the EObject[] representing the all subtypes that must be matched 
     * @param subTypes
     * @param includeSubtypes
     * @since 4.1
     */
    public void setSubTypes( EObject[] subTypes );
    
    /**
     * Set the runtime type that must be matched. 
     * @param runtimeType
     * @since 4.1
     */
    public void setRuntimeType( String runtimeType );
    
}