ActionExecutionDetails


1   /*
2    * Copyright (C) 2005 Alfresco, Inc.
3    *
4    * Licensed under the Mozilla Public License version 1.1 
5    * with a permitted attribution clause. You may obtain a
6    * copy of the License at
7    *
8    *   http://www.alfresco.org/legal/license.txt
9    *
10   * Unless required by applicable law or agreed to in writing,
11   * software distributed under the License is distributed on an
12   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific
14   * language governing permissions and limitations under the
15   * License.
16   */
17  package org.alfresco.service.cmr.action;
18  
19  /**
20   * Action execution details interface.
21   * 
22   * @author Roy Wetherall
23   */
24  public interface ActionExecutionDetails
25  {
26      /**
27       * Gets the title of the action that is being executed.
28       * 
29       * @return  the title of the action
30       */
31      String   getTitle();
32      
33      /**
34       * Gets the action that these execution details relate to.  Will return null
35       * if the action was not saved when it was executed.
36       * 
37       * @return  the action
38       */
39      Action getAction();
40      
41      /**
42       * Get the current execution status.
43       * 
44       * @return  the current execution status
45       */
46      ActionExecutionStatus getExecutionStatus();
47      
48      /**
49       * Gets the error message, null if no error encountered.
50       * 
51       * @return  the error message
52       */
53      String   getErrorMessage();
54      
55      /**
56       * Gets the detailed error message, usually a stack trace.  Null if no
57       * error was encountered.
58       * 
59       * @return  the detailed error message
60       */
61      String   getErrorDetails();
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags