Nautica Workflow

jp.co.argo21.nautica.workflow.omg
インタフェース WfProcess

すべてのスーパーインタフェース:
java.io.Serializable, WfExecutionObject, WfObject

public interface WfProcess
extends WfExecutionObject

WfProcessは、ひとつのビジネスプロセスの管理実体を表すインタフェースである。 本書では、この管理実体を「プロセス」と表記する。 WfProcessは、プロセスの実行を開始する操作、 プロセスによって生成された結果を取得する操作、 WfRequesterやWfActivityとの関連を追加することで、 WfExecutionObjectを特化している。

導入されたバージョン:
Nautica Workflow 0.9
バージョン:
$Revision: 1.2 $

メソッドの概要
 WfActivity[] getActivitiesInState(java.lang.String state)
          引数で指定された状態を持つアクティビティを返す。
 WfActivity[] getAllSteps()
          現時点の全ステップを返す。
 WfProcessManager getManager()
          プロセスは、WfProcessMgrに関連付けられる。
 WfRequester getRequester()
          プロセス要求者を返す。
 WfNameValue[] getResult()
          WfProcessによって生成される結果を返す。
 WfActivity getStep(java.lang.String aid)
          ステップからIDで指定されたアクティビティを返す。
 int getStepCount()
          0以上のWfActiviyがプロセスに関連付けられる。
 boolean isMemberOfStep(WfActivity act)
          引数で指定されたアクティビティが、そのプロセスのステップに所属しているかどうかを返す。
 void setRequester(WfRequester requester)
          プロセス要求者をプロセスに関連付ける。
 void start()
          WfProcessの実行を開始するために使用される。
 
インタフェース jp.co.argo21.nautica.workflow.omg.WfExecutionObject から継承したメソッド
abort, changeState, getAllHistories, getContext, getContext, getDescription, getHistory, getHistoryCount, getID, getLastStateTime, getName, getState, getTransitableStates, resume, setContext, setContext, setDescription, setName, suspend, terminate
 

メソッドの詳細

getRequester

public WfRequester getRequester()
                         throws WorkflowException
プロセス要求者を返す。

戻り値:
プロセス要求者
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

setRequester

public void setRequester(WfRequester requester)
                  throws CannotChangeRequesterException,
                         WorkflowException
プロセス要求者をプロセスに関連付ける。 プロセスが生成された時点で、この関連付けが行われる。 プロセスは、WfRequesterのインタフェースを通じて、状態の変更を通知する。

パラメータ:
requester - プロセス要求者
例外:
CannotChangeRequesterException - プロセス要求者を更新できない場合
WorkflowException - ワークフロー関連で例外が発生した場合

getManager

public WfProcessManager getManager()
                            throws WorkflowException
プロセスは、WfProcessMgrに関連付けられる。 WfProcessが生成される時点で関連付けが行われ、変更はできない。

戻り値:
プロセスマネージャ
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

getStepCount

public int getStepCount()
                 throws WorkflowException
0以上のWfActiviyがプロセスに関連付けられる。 ステップは、現時点でプロセス内でopenな状態であるアクティビティを表すものとする。 ここでは、ステップの個数を返す。

戻り値:
ステップの個数
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

getStep

public WfActivity getStep(java.lang.String aid)
                   throws WorkflowException
ステップからIDで指定されたアクティビティを返す。

パラメータ:
aid - アクティビティID
戻り値:
アクティビティ
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

getAllSteps

public WfActivity[] getAllSteps()
                         throws WorkflowException
現時点の全ステップを返す。

戻り値:
全ステップ
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

isMemberOfStep

public boolean isMemberOfStep(WfActivity act)
                       throws WorkflowException
引数で指定されたアクティビティが、そのプロセスのステップに所属しているかどうかを返す。

パラメータ:
act - アクティビティ
戻り値:
所属している場合はtrue
例外:
WorkflowException - ワークフロー関連で例外が発生した場合

getActivitiesInState

public WfActivity[] getActivitiesInState(java.lang.String state)
                                  throws InvalidStateException,
                                         WorkflowException
引数で指定された状態を持つアクティビティを返す。

パラメータ:
state - 状態
戻り値:
アクティビティ
例外:
InvalidStateException - 不正な状態
WorkflowException - ワークフロー関連で例外が発生した場合

start

public void start()
           throws CannotStartException,
                  AlreadyRunningException,
                  WorkflowException
WfProcessの実行を開始するために使用される。 プロセスの状態は、open.not_runningからopen.runningに変化する。

例外:
CannotStartException - 開始できない場合
AlreadyRunningException - すでに開始している場合
WorkflowException - ワークフロー関連で例外が発生した場合

getResult

public WfNameValue[] getResult()
                        throws ResultNotAvailableException,
                               WorkflowException
WfProcessによって生成される結果を返す。 プロセスが完了するまでは結果は定義されない。 結果の取得がまだ取得できない場合は、例外が発生する。

戻り値:
結果
例外:
ResultNotAvailableException - 結果を取得できない場合
WorkflowException - ワークフロー関連で例外が発生した場合

株式会社アルゴ21


Copyright 2005 株式会社アルゴ21