Overview  Package   Class  Tree  Deprecated  Index  Help 
Novell exteNd
Director 5.2 API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sssw.wf.client
Interface EbiWorkflowEngineDelegate

All Superinterfaces:
EbiDelegate
public interface EbiWorkflowEngineDelegate
extends EbiDelegate

Delegate interface for starting workflow processes.

To get an instance of a workflow engine delegate use EboFactory.getWorkflowEngineDelegate().

Fields inherited from interface com.sssw.fw.api.EbiDelegate
SERVICE_LOCAL, SERVICE_REMOTE
 
Method Summary
 Document getProcessDefinitions(EbiContext context)
          Queries the process definition repository (ResourceSet) and returns a list of process definition candidates for starts.
 int startProcess(String processId, EbiContext context)
          Starts a new process with no starting document.
 int startProcess(String pid, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcess(String processId, String docName, Document doc, EbiContext context)
          Starts a new process with a starting document.
 int startProcess(String pid, String docName, Document doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcess(String processId, String docName, String doc, EbiContext context)
          Starts a new process with a starting document.
 int startProcess(String pid, String docName, String doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcess(String processId, String docName, URL doc, EbiContext context)
          Starts a new process with a starting document.
 int startProcess(String pid, String docName, URL doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcessByName(String processName, EbiContext context)
          Start a new process with no starting document.
 int startProcessByName(String processName, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcessByName(String processName, String docName, Document doc, EbiContext context)
          Start a new process with a starting document.
 int startProcessByName(String processName, String docName, Document doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcessByName(String processName, String docName, String doc, EbiContext context)
          Start a new process with a starting document.
 int startProcessByName(String processName, String docName, String doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 int startProcessByName(String processName, String docName, URL doc, EbiContext context)
          Start a new process with a starting document.
 int startProcessByName(String processName, String docName, URL doc, EbiContext context, com.sssw.wf.client.EbiProperty[] properties)
          Start a new process.
 
Methods implemented from interface com.sssw.fw.api.EbiDelegate
getName
 

Method Detail

startProcess

public int startProcess(String processId,
                        EbiContext context)
                 throws EboEngineException
Starts a new process with no starting document. If the receiver is not in a running state it refuses the start request.
Parameters:
processId - - process id
context - - a workflow context
Returns:
int indicating success or failure:

Value

Meaning

0

success

-1

engine not running; unable to start process

-2

process definition not found

-3

process suspended

startProcess

public int startProcess(String pid,
                        EbiContext context,
                        com.sssw.wf.client.EbiProperty[] properties)
                 throws EboEngineException
Start a new process.
Parameters:
pid - process id
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcess

public int startProcess(String processId,
                        String docName,
                        Document doc,
                        EbiContext context)
                 throws EboEngineException
Starts a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
id - - process id
docName - - document name
doc - - starting document (DOM)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context ).

startProcess

public int startProcess(String pid,
                        String docName,
                        Document doc,
                        EbiContext context,
                        com.sssw.wf.client.EbiProperty[] properties)
                 throws EboEngineException
Start a new process.
Parameters:
pid - process id
docName - document name
doc - starting document as org.w3c.dom.Document
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcess

public int startProcess(String processId,
                        String docName,
                        String doc,
                        EbiContext context)
                 throws EboEngineException
Starts a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
id - - process id
docName - - document name
doc - - starting document (String)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcess

public int startProcess(String pid,
                        String docName,
                        String doc,
                        EbiContext context,
                        com.sssw.wf.client.EbiProperty[] properties)
                 throws EboEngineException
Start a new process.
Parameters:
pid - process id
docName - document name
doc - starting document as java.lang.String
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcess

public int startProcess(String processId,
                        String docName,
                        URL doc,
                        EbiContext context)
                 throws EboEngineException
Starts a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
id - - process id
docName - - document name
doc - - starting document (URL)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcess

public int startProcess(String pid,
                        String docName,
                        URL doc,
                        EbiContext context,
                        com.sssw.wf.client.EbiProperty[] properties)
                 throws EboEngineException
Start a new process.
Parameters:
pid - process id
docName - document name
doc - starting document as java.net.URL
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcessByName

public int startProcessByName(String processName,
                              EbiContext context)
                       throws EboEngineException
Start a new process with no starting document. If the receiver is not in a running state refuse the start request.
Parameters:
processId - - process id
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcessByName

public int startProcessByName(String processName,
                              EbiContext context,
                              com.sssw.wf.client.EbiProperty[] properties)
                       throws EboEngineException
Start a new process.
Parameters:
processName - process name
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              Document doc,
                              EbiContext context)
                       throws EboEngineException
Start a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
processName - - process name
docName - - document name
doc - - starting document (DOM)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              Document doc,
                              EbiContext context,
                              com.sssw.wf.client.EbiProperty[] properties)
                       throws EboEngineException
Start a new process.
Parameters:
processName - process name
docName - document name
doc - starting document as org.w3c.dom.Document
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              String doc,
                              EbiContext context)
                       throws EboEngineException
Start a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
processName - - process name
docName - - document name
doc - - starting document (String)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              String doc,
                              EbiContext context,
                              com.sssw.wf.client.EbiProperty[] properties)
                       throws EboEngineException
Start a new process.
Parameters:
processName - process name
docName - document name
doc - starting document as java.lang.String
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              URL doc,
                              EbiContext context)
                       throws EboEngineException
Start a new process with a starting document. If the receiver is not in a running state refuse the start request.
Parameters:
processName - - process name
docName - - document name
doc - - starting document (URL)
context - - a workflow context
Returns:
int indicating success or failure. For return values see EbiWorkflowEngineDelegate.startProcess( String processId, EbiContext context).

startProcessByName

public int startProcessByName(String processName,
                              String docName,
                              URL doc,
                              EbiContext context,
                              com.sssw.wf.client.EbiProperty[] properties)
                       throws EboEngineException
Start a new process.
Parameters:
processName - process name
docName - document name
doc - starting document as java.net.URL
context - portal context
properties - process properties
Throws:
EboEngineException - if the process cannot be started

getProcessDefinitions

public Document getProcessDefinitions(EbiContext context)
                               throws EboEngineException
Queries the process definition repository (ResourceSet) and returns a list of process definition candidates for starts.
Parameters:
context - - a workflow context
Returns:
process list - the list of available processes as a DOM. It adheres to workflow-process_3_0.dtd. The dtd is located in your Director EAR project in the library/WorkflowService/WorkflowService-cong/DTD directory.
Throws:
EboEngineException -  
Overview  Package   Class  Tree  Deprecated  Index  Help 
Novell exteNd
Director 5.2 API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD