01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.portal.event;
18:
19: import org.apache.avalon.framework.component.Component;
20:
21: /**
22: * Convert events from and into strings
23: *
24: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
25: * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
26: *
27: * @version CVS $Id: EventConverter.java 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface EventConverter extends Component {
30:
31: String ROLE = EventConverter.class.getName();
32:
33: /**
34: * Encode an event.
35: * This is used to "activate" events using a link
36: * @param event The event to encode
37: * @return A unique string representation for this event
38: */
39: String encode(Event event);
40:
41: /**
42: * Decode an event
43: * This is used to "activate" events using a link
44: * @param value The string representation created using {@link #encode(Event)}
45: * @return The event or null
46: */
47: Event decode(String value);
48:
49: /**
50: * This notifies the converter that a new event processing phase starts
51: */
52: void start();
53:
54: /**
55: * This notifies the converter that an event processing phase ends
56: */
57: void finish();
58:
59: /**
60: * Returns true if events are not to be returned as request parameters
61: */
62: boolean isMarshallEvents();
63: }
|