KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > asyncprocess > AsyncProcessResult


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.services.asyncprocess;
66
67 /**
68  * AsyncProcessResult a wrpper interface for what is handed back to the client
69  * when a process is waiting, running, or completed..
70  *
71  * @author Michael Rimov
72  * @version $Revision: 1.4 $ on $Date: 2004/11/17 20:48:17 $
73  */
74
75 public interface AsyncProcessResult {
76
77     /**
78      * Status code for the process is still waiting in queue.
79      */
80     public static final int STATUS_PENDING = 0;
81
82     /**
83      * Status code for the process is currently running
84      */
85     public static final int STATUS_RUNNING = 1;
86
87     /**
88      * Status code for the process is complete
89      */
90     public static final int STATUS_COMPLETE = 2;
91
92     /**
93      * Status code for there has been an error processing the AsyncProcess.
94      * Use getException() to retrieve the actual exception thrown
95      */
96     public static final int STATUS_FAULT = 3;
97
98     /**
99      * Retrieve the status code of the process.
100      *
101      * @return integer the status code, one of the status fields listed above
102      */
103     public int getStatusCode();
104
105
106     /**
107      * Retrieve the exception that occured during the processing. [If one
108      * exists]
109      *
110      * @return The Exception thrown or null if there is none available.
111      */
112     public Throwable JavaDoc getException();
113
114
115     /**
116      * Retrieve the result of the Object
117      *
118      * @return java.lang.Object the result of the processing
119      */
120     public Object JavaDoc getResult();
121
122     /**
123      * Retrieve the status object
124      *
125      * @return java.lang.Object the status of the object
126      */
127     public Object JavaDoc getStatus();
128
129
130     /**
131      * Get the asynchronous process
132      *
133      * @return AsyncProcess the async process object that was originally queued
134      */
135     public AsyncProcess getOriginalProcess();
136
137 }
138
139
Popular Tags