001    // Copyright 2010 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    // http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.internal.services;
016    
017    import java.io.IOException;
018    
019    import org.apache.tapestry5.ComponentResources;
020    import org.apache.tapestry5.EventConstants;
021    import org.apache.tapestry5.EventContext;
022    import org.apache.tapestry5.services.ComponentEventResultProcessor;
023    
024    /**
025     * Responsible for firing the {@linkplain EventConstants#ACTIVATE} event on the page.
026     * 
027     * @since 5.2.0
028     */
029    public interface PageActivator
030    {
031        /**
032         * Activates the page.
033         * 
034         * @param pageResources
035         *            resource for the page
036         * @param activationContext
037         *            the page activation context
038         * @param resultProcessor
039         *            responsible for handling the value returned from the event handler method
040         * @return true if result processor received a non-null value (indicating that the processing of the request
041         *         should terminate)
042         */
043        @SuppressWarnings("unchecked")
044        boolean activatePage(ComponentResources pageResources, EventContext activationContext,
045                ComponentEventResultProcessor resultProcessor) throws IOException;
046    }