Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
IExternalPage |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry; | |
16 | ||
17 | /** | |
18 | * Defines a page which may be referenced externally via a URL using the | |
19 | * {@link org.apache.tapestry.engine.ExternalService}. External pages may be bookmarked via their | |
20 | * URL for latter display. See the {@link org.apache.tapestry.link.ExternalLink} for details on how | |
21 | * to invoke <tt>IExternalPage</tt>s. | |
22 | * | |
23 | * @see org.apache.tapestry.callback.ExternalCallback | |
24 | * @see org.apache.tapestry.engine.ExternalService | |
25 | * @author Howard Lewis Ship | |
26 | * @author Malcolm Edgar | |
27 | * @since 2.2 | |
28 | */ | |
29 | ||
30 | public interface IExternalPage extends IPage | |
31 | { | |
32 | /** | |
33 | * Initialize the external page with the given array of parameters and request cycle. | |
34 | * <p> | |
35 | * This method is invoked after {@link IPage#validate(IRequestCycle)}. | |
36 | * | |
37 | * @param parameters | |
38 | * the array of listener parameters | |
39 | * @param cycle | |
40 | * current request cycle | |
41 | */ | |
42 | ||
43 | void activateExternalPage(Object[] parameters, IRequestCycle cycle); | |
44 | } |