001//  Copyright 2008, 2009 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
015package org.apache.tapestry5.internal.services;
016
017/**
018 * Fires the {@link org.apache.tapestry5.EventConstants#PASSIVATE} event on a page, and collects the result, converting
019 * it to an array of objects.
020 */
021public interface PageActivationContextCollector
022{
023    /**
024     * Fires the passivate event and collects the response, which is coerced to an object array. A page that does not
025     * have an event handler for the passivate event will return an empty array.
026     *
027     * @param pageName to collect context from ; this should be the canonical page name
028     * @return the activation context, or an empty array of the page does not provide a context
029     */
030    Object[] collectPageActivationContext(String pageName);
031}