KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > record > PropertyPersistenceStrategySource


1 // Copyright 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.record;
16
17 import java.util.Collection JavaDoc;
18
19 import org.apache.tapestry.IRequestCycle;
20 import org.apache.tapestry.engine.ServiceEncoding;
21
22 /**
23  * A source for {@link org.apache.tapestry.record.PropertyPersistenceStrategy}s.
24  *
25  * @author Howard M. Lewis Ship
26  * @since 4.0
27  */
28 public interface PropertyPersistenceStrategySource
29 {
30     /**
31      * Returns the name strategy.
32      *
33      * @param name
34      * the name of the strategy to retrieve.
35      * @throws org.apache.hivemind.ApplicationRuntimeException
36      * if no such strategy exists.
37      */
38     public PropertyPersistenceStrategy getStrategy(String JavaDoc name);
39
40     /**
41      * Returns all changes ({@link PropertyChange}) collected by any persistence strategy for the
42      * page. May return an empty list.
43      *
44      * @see PropertyPersistenceStrategy#getStoredChanges(String, IRequestCycle)
45      */
46
47     public Collection JavaDoc getAllStoredChanges(String JavaDoc pageName, IRequestCycle cycle);
48
49     /**
50      * Discards any stored property changes for the named page.
51      */
52
53     public void discardAllStoredChanged(String JavaDoc pageName, IRequestCycle cycle);
54
55     /**
56      * Invoked by a {@link org.apache.tapestry.services.LinkFactory} , the parameters may be
57      * modified (added to) to store information related to persistent properties. This method is
58      * forwarded to all {@link PropertyPersistenceStrategy}s.
59      *
60      * @param encoding
61      * Service encoding, which indentifies the URL and the query parameters from which
62      * the {@link org.apache.tapestry.engine.ILink} will be created.
63      * @param cycle
64      * The current request cycle.
65      * @see PropertyPersistenceStrategySource
66      */
67
68     public void addParametersForPersistentProperties(ServiceEncoding encoding, IRequestCycle cycle);
69 }
Popular Tags