org.enhydra.shark.corba.poa
Class WfProcessCORBA

java.lang.Object
  extended by org.omg.PortableServer.Servant
      extended by org.omg.WorkflowModel.WfProcessPOA
          extended by org.enhydra.shark.corba.poa.WfProcessCORBA
All Implemented Interfaces:
org.omg.CORBA.portable.InvokeHandler, BaseBusinessObjectOperations, WfExecutionObjectOperations, WfProcessOperations

public class WfProcessCORBA
extends WfProcessPOA

WfProcessImpl - Workflow Process Object implementation

Version:
1.0
Author:
David Forslund

Constructor Summary
protected WfProcessCORBA(org.omg.CORBA.ORB orb, Collective toJoin, WfProcess sharkProc)
          Creates new WfProcessImpl
 
Method Summary
 void abort()
          Abort the execution of this process.
 void change_state(java.lang.String new_state)
           
 java.lang.String description()
           
 boolean equals(java.lang.Object obj)
          It is assumed that there can't be two or more processes having the same key.
 WfActivityIterator get_activities_in_state(java.lang.String state)
          Retrieve the iterator of activities in some specific state.
 WfEventAuditIterator get_iterator_history(java.lang.String query, NameValue[] names_in_query)
          Search in the history for specific elements.
 WfActivityIterator get_iterator_step()
          Retrieve the Iterator of active activities of this process.
 WfEventAudit[] get_sequence_history(int max_number)
          Getter for history sequence.
 WfActivity[] get_sequence_step(int max_number)
          Retrieve the List of activities of this process.
 how_closedType how_closed()
           
 int how_many_history()
           
 int how_many_step()
          Retrieve the no of activities in this process.
 boolean is_member_of_history(WfExecutionObject member)
          Checks if a 'member' is an element of the history.
 boolean is_member_of_step(WfActivity member)
          Check if some activity is a member of this process.
 java.lang.String key()
           
 org.omg.TimeBase.UtcT last_state_time()
           
 WfProcessMgr manager()
          Retrieve the WfProcessMgr of this process.
 java.lang.String name()
           
 short priority()
           
 NameValue[] process_context()
           
 WfRequester requester()
          Retrieve the requestor of this process.
 NameValue[] result()
          Retrieve the result for this process.
 void resume()
          Resume this process.
 void set_description(java.lang.String new_value)
           
 void set_name(java.lang.String new_value)
           
 void set_priority(short new_value)
           
 void set_process_context(NameValue[] new_value)
           
 void set_requester(WfRequester new_value)
          Set the requester for this process.
 void start()
          Starts the process - creates a separate thread.
 java.lang.String state()
           
 void suspend()
          Suspend this process.
 void terminate()
          Terminate this process.
 java.lang.String toString()
           
 java.lang.String[] valid_states()
           
 while_openType while_open()
           
 why_not_runningType why_not_running()
           
 workflow_stateType workflow_state()
           
 
Methods inherited from class org.omg.WorkflowModel.WfProcessPOA
_all_interfaces, _invoke, _this, _this
 
Methods inherited from class org.omg.PortableServer.Servant
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WfProcessCORBA

protected WfProcessCORBA(org.omg.CORBA.ORB orb,
                         Collective toJoin,
                         WfProcess sharkProc)
Creates new WfProcessImpl

Parameters:
sharkProc - a WfProcess
Method Detail

requester

public WfRequester requester()
                      throws BaseException
Retrieve the requestor of this process.

Throws:
BaseException

set_requester

public void set_requester(WfRequester new_value)
                   throws BaseException,
                          CannotChangeRequester
Set the requester for this process.

Throws:
BaseException
CannotChangeRequester

how_many_step

public int how_many_step()
                  throws BaseException
Retrieve the no of activities in this process.

Throws:
BaseException

get_iterator_step

public WfActivityIterator get_iterator_step()
                                     throws BaseException
Retrieve the Iterator of active activities of this process.

Throws:
BaseException

get_sequence_step

public WfActivity[] get_sequence_step(int max_number)
                               throws BaseException
Retrieve the List of activities of this process.

Parameters:
max_number - High limit of elements in the result set (0->all).
Throws:
BaseException

is_member_of_step

public boolean is_member_of_step(WfActivity member)
                          throws BaseException
Check if some activity is a member of this process.

Returns:
true if the specific activity is a member of this process, false otherwise.
Throws:
BaseException

manager

public WfProcessMgr manager()
                     throws BaseException
Retrieve the WfProcessMgr of this process.

Throws:
BaseException

result

public NameValue[] result()
                   throws BaseException,
                          ResultNotAvailable
Retrieve the result for this process.

Throws:
BaseException
ResultNotAvailable

start

public void start()
           throws BaseException,
                  CannotStart,
                  AlreadyRunning
Starts the process - creates a separate thread.

Throws:
BaseException
CannotStart
AlreadyRunning

get_activities_in_state

public WfActivityIterator get_activities_in_state(java.lang.String state)
                                           throws BaseException,
                                                  InvalidState
Retrieve the iterator of activities in some specific state.

Throws:
BaseException
InvalidState

workflow_state

public workflow_stateType workflow_state()
                                  throws BaseException
Throws:
BaseException

while_open

public while_openType while_open()
                          throws BaseException
Throws:
BaseException

why_not_running

public why_not_runningType why_not_running()
                                    throws BaseException
Throws:
BaseException

how_closed

public how_closedType how_closed()
                          throws BaseException
Throws:
BaseException

valid_states

public java.lang.String[] valid_states()
                                throws BaseException
Throws:
BaseException

state

public java.lang.String state()
                       throws BaseException
Throws:
BaseException

change_state

public void change_state(java.lang.String new_state)
                  throws BaseException,
                         InvalidState,
                         TransitionNotAllowed
Throws:
BaseException
InvalidState
TransitionNotAllowed

name

public java.lang.String name()
                      throws BaseException
Throws:
BaseException

set_name

public void set_name(java.lang.String new_value)
              throws BaseException
Throws:
BaseException

key

public java.lang.String key()
                     throws BaseException
Throws:
BaseException

description

public java.lang.String description()
                             throws BaseException
Throws:
BaseException

set_description

public void set_description(java.lang.String new_value)
                     throws BaseException
Throws:
BaseException

process_context

public NameValue[] process_context()
                            throws BaseException
Throws:
BaseException

set_process_context

public void set_process_context(NameValue[] new_value)
                         throws BaseException,
                                InvalidData,
                                UpdateNotAllowed
Throws:
BaseException
InvalidData
UpdateNotAllowed

priority

public short priority()
               throws BaseException
Throws:
BaseException

set_priority

public void set_priority(short new_value)
                  throws BaseException
Throws:
BaseException

resume

public void resume()
            throws BaseException,
                   CannotResume,
                   NotSuspended
Resume this process.

Throws:
BaseException
CannotResume
NotSuspended

suspend

public void suspend()
             throws BaseException,
                    CannotSuspend,
                    NotRunning,
                    AlreadySuspended
Suspend this process.

Throws:
BaseException
CannotSuspend
NotRunning
AlreadySuspended

terminate

public void terminate()
               throws BaseException,
                      CannotStop,
                      NotRunning
Terminate this process.

Throws:
BaseException
CannotStop
NotRunning

abort

public void abort()
           throws BaseException,
                  CannotStop,
                  NotRunning
Abort the execution of this process.

Throws:
BaseException
CannotStop
NotRunning

how_many_history

public int how_many_history()
                     throws BaseException,
                            HistoryNotAvailable
Throws:
BaseException
HistoryNotAvailable

get_iterator_history

public WfEventAuditIterator get_iterator_history(java.lang.String query,
                                                 NameValue[] names_in_query)
                                          throws BaseException,
                                                 HistoryNotAvailable
Search in the history for specific elements.

Returns:
Found history elements that meet the search criteria.
Throws:
BaseException
HistoryNotAvailable

get_sequence_history

public WfEventAudit[] get_sequence_history(int max_number)
                                    throws BaseException,
                                           HistoryNotAvailable
Getter for history sequence.

Returns:
List of History objects.
Throws:
BaseException
HistoryNotAvailable

is_member_of_history

public boolean is_member_of_history(WfExecutionObject member)
                             throws BaseException
Checks if a 'member' is an element of the history.

Returns:
true if the element of the history, false otherwise.
Throws:
BaseException

last_state_time

public org.omg.TimeBase.UtcT last_state_time()
                                      throws BaseException
Throws:
BaseException

equals

public boolean equals(java.lang.Object obj)
It is assumed that there can't be two or more processes having the same key.

Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object