WorkflowRemote


1   /*
2    * Copyright (c) 2002-2003 by OpenSymphony
3    * All rights reserved.
4    */
5   /*
6    * Generated by XDoclet - Do not edit!
7    */
8   package com.opensymphony.workflow.ejb;
9   
10  
11  /**
12   * Remote interface for Workflow.
13   * @author <a HREF="mailto:plightbo@hotmail.com">Pat Lightbody</a>
14   * @author <a HREF="mailto:hani@formicary.net">Hani Suleiman</a>
15   * @version $Revision: 1.5 $
16   */
17  public interface WorkflowRemote extends javax.ejb.EJBObject   {
18      //~ Methods ////////////////////////////////////////////////////////////////
19  
20      public int[] getAvailableActions(long id) throws java.rmi.RemoteException  ;
21  
22      /**
23       * Get the available actions for the specified workflow instance.
24       * @param id The workflow instance id.
25       * @param inputs The inputs map to pass on to conditions
26       * @return An array of action id's that can be performed on the specified entry.
27       * @throws IllegalArgumentException if the specified id does not exist, or if its workflow descriptor is no longer available or has become invalid.    */
28      public int[] getAvailableActions(long id, java.util.Map   inputs) throws java.rmi.RemoteException  ;
29  
30      public void setConfiguration(com.opensymphony.workflow.config.Configuration configuration) throws java.rmi.RemoteException  ;
31  
32      public java.util.List   getCurrentSteps(long id) throws java.rmi.RemoteException  ;
33  
34      public int getEntryState(long id) throws java.rmi.RemoteException  ;
35  
36      public java.util.List   getHistorySteps(long id) throws java.rmi.RemoteException  ;
37  
38      public java.util.Properties   getPersistenceProperties() throws java.rmi.RemoteException  ;
39  
40      /**
41       * Get the PropertySet for the specified workflow ID
42       * @param id The workflow ID    */
43      public com.opensymphony.module.propertyset.PropertySet getPropertySet(long id) throws java.rmi.RemoteException  ;
44  
45      public java.util.List   getSecurityPermissions(long id) throws java.rmi.RemoteException  ;
46  
47      /**
48       * Returns a workflow definition object associated with the given name.
49       * @param workflowName the name of the workflow
50       * @return the object graph that represents a workflow definition
51       */
52      public com.opensymphony.workflow.loader.WorkflowDescriptor getWorkflowDescriptor(java.lang.String   workflowName) throws java.rmi.RemoteException  ;
53  
54      public java.lang.String   getWorkflowName(long id) throws java.rmi.RemoteException  ;
55  
56      /**
57       * Get a list of workflow names available
58       * @return String[] an array of workflow names.
59       */
60      public java.lang.String  [] getWorkflowNames() throws java.rmi.RemoteException  ;
61  
62      public boolean canInitialize(java.lang.String   workflowName, int initialAction) throws java.rmi.RemoteException  ;
63  
64      public boolean canInitialize(java.lang.String   workflowName, int initialAction, java.util.Map   inputs) throws java.rmi.RemoteException  ;
65  
66      public boolean canModifyEntryState(long id, int newState) throws java.rmi.RemoteException  ;
67  
68      public void changeEntryState(long id, int newState) throws com.opensymphony.workflow.WorkflowException, java.rmi.RemoteException  ;
69  
70      public void doAction(long id, int actionId, java.util.Map   inputs) throws com.opensymphony.workflow.WorkflowException, java.rmi.RemoteException  ;
71  
72      public void executeTriggerFunction(long id, int triggerId) throws com.opensymphony.workflow.WorkflowException, java.rmi.RemoteException  ;
73  
74      public long initialize(java.lang.String   workflowName, int initialAction, java.util.Map   inputs) throws com.opensymphony.workflow.InvalidRoleException, com.opensymphony.workflow.InvalidInputException, com.opensymphony.workflow.StoreException, com.opensymphony.workflow.WorkflowException, java.rmi.RemoteException  ;
75  
76      public java.util.List   query(com.opensymphony.workflow.query.WorkflowQuery query) throws com.opensymphony.workflow.StoreException, java.rmi.RemoteException  ;
77  
78      public java.util.List   query(com.opensymphony.workflow.query.WorkflowExpressionQuery query) throws com.opensymphony.workflow.WorkflowException, java.rmi.RemoteException  ;
79  
80      public boolean removeWorkflowDescriptor(java.lang.String   workflowName) throws com.opensymphony.workflow.FactoryException, java.rmi.RemoteException  ;
81  
82      public boolean saveWorkflowDescriptor(java.lang.String   workflowName, com.opensymphony.workflow.loader.WorkflowDescriptor descriptor, boolean replace) throws com.opensymphony.workflow.FactoryException, java.rmi.RemoteException  ;
83  }
84
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags