001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.asyncprocess;
066:
067: /**
068: * AsyncProcessResult a wrpper interface for what is handed back to the client
069: * when a process is waiting, running, or completed..
070: *
071: * @author Michael Rimov
072: * @version $Revision: 1.4 $ on $Date: 2004/11/17 20:48:17 $
073: */
074:
075: public interface AsyncProcessResult {
076:
077: /**
078: * Status code for the process is still waiting in queue.
079: */
080: public static final int STATUS_PENDING = 0;
081:
082: /**
083: * Status code for the process is currently running
084: */
085: public static final int STATUS_RUNNING = 1;
086:
087: /**
088: * Status code for the process is complete
089: */
090: public static final int STATUS_COMPLETE = 2;
091:
092: /**
093: * Status code for there has been an error processing the AsyncProcess.
094: * Use getException() to retrieve the actual exception thrown
095: */
096: public static final int STATUS_FAULT = 3;
097:
098: /**
099: * 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: * Retrieve the exception that occured during the processing. [If one
107: * exists]
108: *
109: * @return The Exception thrown or null if there is none available.
110: */
111: public Throwable getException();
112:
113: /**
114: * Retrieve the result of the Object
115: *
116: * @return java.lang.Object the result of the processing
117: */
118: public Object getResult();
119:
120: /**
121: * Retrieve the status object
122: *
123: * @return java.lang.Object the status of the object
124: */
125: public Object getStatus();
126:
127: /**
128: * Get the asynchronous process
129: *
130: * @return AsyncProcess the async process object that was originally queued
131: */
132: public AsyncProcess getOriginalProcess();
133:
134: }
|