NotifyingBuilder


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.components.notification;
17  
18  import java.util.Map  ;
19  
20  import org.apache.avalon.framework.component.Component;
21  
22  /**
23   *  Generates an Notifying representation of widely used objects.
24   *
25   * @author <a HREF="mailto:barozzi@nicolaken.com">Nicola Ken Barozzi</a>
26   * @version CVS $Id: NotifyingBuilder.java 30932 2004-07-29 17:35:38Z vgritsenko $
27   */
28  
29  public interface NotifyingBuilder extends Component{
30  
31    /**
32    * The role implemented by a <code>NotifyingBuilder</code>.
33    */
34    String   ROLE = NotifyingBuilder.class.getName();
35  
36    /** Builds a Notifying object (SimpleNotifyingObject in this case)
37     *  that tries to explain what the Object o can reveal.
38     * @param sender who sent this Object.
39     * @param o the object to use when building the SimpleNotifyingObject
40     * @return the  Notifying Object that was build
41     * @see org.apache.cocoon.components.notification.Notifying
42     */
43    Notifying build(Object   sender, Object   o);
44  
45  
46    /** Builds a Notifying object (SimpleNotifyingObject in this case)
47     *  that explains a notification.
48     * @param sender who sent this Object.
49     * @param o the object to use when building the SimpleNotifyingObject
50     * @param type see the Notifying apidocs
51     * @param title see the Notifying apidocs
52     * @param source see the Notifying apidocs
53     * @param message see the Notifying apidocs
54     * @param description see the Notifying apidocs
55     * @param extra see the Notifying apidocs
56     * @return the  Notifying Object that was build
57     * @see org.apache.cocoon.components.notification.Notifying
58     */
59    Notifying build(Object   sender, Object   o, String   type, String   title,
60            String   source, String   message, String   description, Map   extra);
61  }
62  
63  
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags