DynamicComponentFactory.java

/*
 * � Copyright IBM Corp. 2010
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at:
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 * implied. See the License for the specific language governing 
 * permissions and limitations under the License.
 */
package com.ibm.xsp.extlib.builder;

import com.ibm.xsp.page.FacesPageDriver;


/**
 * Dynamic component factory.
 * <p>
 * This interface should be implemented by the component which dynamically construct
 * XPages components, without relying on the compiled pages, but on its own mechanism
 * for constructing the hierarchy. 
 * Note: This is for very advanced use cases, like an XPages interpreter
 * </p>
 */
public interface DynamicComponentFactory {

    /**
     * Get the FacesPageDriver involved.
     * @return
     */
    public FacesPageDriver getPageDriver();
    
    /**
     * Get a string that identifies a source for code.
     * @return
     */
    public String getSourceComponentRef();
}