KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > notification > Notifying


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 JavaDoc;
19
20 /**
21  * Interface for Objects that can notify something.
22  *
23  * @author <a HREF="mailto:barozzi@nicolaken.com">Nicola Ken Barozzi</a>
24  * @version CVS $Id: Notifying.java 30932 2004-07-29 17:35:38Z vgritsenko $
25  */
26
27 public interface Notifying {
28
29     /*
30      * Proposed types of notifications
31      */
32     String JavaDoc UNKNOWN_NOTIFICATION = "unknown";
33     String JavaDoc DEBUG_NOTIFICATION = "debug";
34     String JavaDoc INFO_NOTIFICATION = "info" ;
35     String JavaDoc WARN_NOTIFICATION = "warn" ;
36     String JavaDoc ERROR_NOTIFICATION = "error";
37     String JavaDoc FATAL_NOTIFICATION = "fatal";
38
39     /*
40      * Proposed extra descriptions
41      */
42     String JavaDoc EXTRA_LOCATION = "location";
43     String JavaDoc EXTRA_LINE = "line";
44     String JavaDoc EXTRA_COLUMN = "column" ;
45     String JavaDoc EXTRA_REQUESTURI = "request-uri" ;
46     String JavaDoc EXTRA_CAUSE = "cause";
47     String JavaDoc EXTRA_STACKTRACE = "stacktrace";
48     String JavaDoc EXTRA_FULLTRACE = "full exception chain stacktrace";
49
50     /**
51      * Gets the Type of the Notifying object
52      */
53     String JavaDoc getType();
54
55     /**
56      * Gets the Title of the Notifying object
57      */
58     String JavaDoc getTitle();
59
60     /**
61      * Gets the Source of the Notifying object
62      */
63     String JavaDoc getSource();
64
65     /**
66      * Gets the Sender of the Notifying object
67      */
68     String JavaDoc getSender();
69
70     /**
71      * Gets the Message of the Notifying object
72      */
73     String JavaDoc getMessage();
74
75     /**
76      * Gets the Description of the Notifying object
77      */
78     String JavaDoc getDescription();
79
80     /**
81      * Gets the ExtraDescriptions of the Notifying object
82      */
83     Map JavaDoc getExtraDescriptions();
84 }
85
Popular Tags