Nautica Workflow

jp.co.argo21.nautica.workflow.wfmc
インタフェース WorkflowEngineHandler

既知の実装クラスの一覧:
WorkflowEngineHandlerImpl

public interface WorkflowEngineHandler

ワークフローエンジンハンドラは、ワークフローエンジンに対する クライアントインタフェースである。

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

メソッドの概要
 void assignActivityAttribute(java.lang.String session, java.lang.String pid, java.lang.String aid, Attribute attr)
          アクティビティインスタンス属性の割り当てを行う。
 void assignProcessAttribute(java.lang.String session, java.lang.String pid, Attribute attr)
          プロセスインスタンス属性の割り当てを行う。
 void changeActivityState(java.lang.String session, java.lang.String pid, java.lang.String aid, ActivityState state)
          アクティビティインスタンス状態の変更を行う。
 void changeProcessState(java.lang.String session, java.lang.String pid, ProcessState state)
          プロセスインスタンス状態の変更を行う。
 java.lang.String createProcess(java.lang.String session, java.lang.String pdid, java.lang.String name)
          プロセスインスタンスの生成を行う。
 Activity[] getActivities(java.lang.String session, Filter filter)
          アクティビティインスタンス一覧の取得を行う。
 Activity[] getActivities(java.lang.String session, java.lang.String pid, Filter filter)
          アクティビティインスタンス一覧の取得を行う。
 Activity getActivity(java.lang.String session, java.lang.String pid, java.lang.String aid)
          アクティビティインスタンスの取得を行う。
 Attribute[] getActivityAttributes(java.lang.String session, java.lang.String pid, java.lang.String aid, Filter filter)
          アクティビティインスタンス属性一覧の取得を行う。
 Attribute getActivityAttributeValue(java.lang.String session, java.lang.String pid, java.lang.String aid, java.lang.String name)
          アクティビティインスタンス属性の属性値の取得を行う。
 ActivityState[] getActivityStates(java.lang.String session, java.lang.String pid, java.lang.String aid, Filter filter)
          指定されたアクティビティインスタンスが利用可能な状態一覧の取得を行う。
 Process getProcess(java.lang.String session, java.lang.String pid)
          プロセスインスタンスの取得を行う。
 Attribute[] getProcessAttributes(java.lang.String session, java.lang.String pid, Filter filter)
          プロセスインスタンス属性一覧の取得を行う。
 Attribute getProcessAttributeValue(java.lang.String session, java.lang.String pid, java.lang.String name)
          プロセスインスタンス属性の属性値の取得を行う。
 Process[] getProcesses(java.lang.String session, Filter filter)
          プロセスインスタンス一覧の取得を行う。
 ProcessState[] getProcessStates(java.lang.String session, java.lang.String pid, Filter filter)
          指定されたプロセスインスタンスが利用可能な状態一覧の取得を行う。
 java.lang.String startProcess(java.lang.String session, java.lang.String pid)
          プロセスインスタンスの開始を行う。
 void terminateProcess(java.lang.String session, java.lang.String pid)
          プロセスインスタンスの停止を行う。
 

メソッドの詳細

createProcess

public java.lang.String createProcess(java.lang.String session,
                                      java.lang.String pdid,
                                      java.lang.String name)
                               throws InvalidSessionException,
                                      InvalidProcessDefinitionException
プロセスインスタンスの生成を行う。

パラメータ:
session - セッションID
pdid - プロセス定義ID
name - プロセスインスタンス名称
戻り値:
プロセスインスタンスID
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessDefinitionException - 指定されたプロセス定義IDが有効でない場合

startProcess

public java.lang.String startProcess(java.lang.String session,
                                     java.lang.String pid)
                              throws InvalidSessionException,
                                     InvalidProcessInstanceException,
                                     InvalidAttributeException
プロセスインスタンスの開始を行う。 開始した場合に、プロセスインスタンスIDを更新するような 実装も可能である。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
戻り値:
更新されたプロセスインスタンスID
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidAttributeException - 属性が有効でない場合

terminateProcess

public void terminateProcess(java.lang.String session,
                             java.lang.String pid)
                      throws InvalidSessionException,
                             InvalidProcessInstanceException
プロセスインスタンスの停止を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合

getProcessStates

public ProcessState[] getProcessStates(java.lang.String session,
                                       java.lang.String pid,
                                       Filter filter)
                                throws InvalidSessionException,
                                       InvalidProcessInstanceException,
                                       InvalidFilterException
指定されたプロセスインスタンスが利用可能な状態一覧の取得を行う。 利用可能なフィルターはStateFilterのみとする。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
filter - 検索用フィルター
戻り値:
プロセスインスタンス状態一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidFilterException - 指定されたフィルターが有効でない場合

changeProcessState

public void changeProcessState(java.lang.String session,
                               java.lang.String pid,
                               ProcessState state)
                        throws InvalidSessionException,
                               InvalidProcessInstanceException,
                               InvalidStateException,
                               TransitionNotAllowedException
プロセスインスタンス状態の変更を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
state - プロセスインスタンス状態
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidStateException - 指定された状態が有効でない場合
TransitionNotAllowedException - 状態の変更が許可されていない場合

getProcessAttributes

public Attribute[] getProcessAttributes(java.lang.String session,
                                        java.lang.String pid,
                                        Filter filter)
                                 throws InvalidSessionException,
                                        InvalidProcessInstanceException,
                                        InvalidFilterException
プロセスインスタンス属性一覧の取得を行う。 利用可能なフィルターはNameFilter, AttributeFilter, GroupFilterとする。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
filter - 検索用フィルター
戻り値:
属性一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidFilterException - 指定されたフィルターが有効でない場合

getProcessAttributeValue

public Attribute getProcessAttributeValue(java.lang.String session,
                                          java.lang.String pid,
                                          java.lang.String name)
                                   throws InvalidSessionException,
                                          InvalidAttributeException
プロセスインスタンス属性の属性値の取得を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
name - 属性名
戻り値:
属性
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidAttributeException - 属性が有効でない場合

assignProcessAttribute

public void assignProcessAttribute(java.lang.String session,
                                   java.lang.String pid,
                                   Attribute attr)
                            throws InvalidSessionException,
                                   InvalidProcessInstanceException,
                                   InvalidAttributeException,
                                   AttributeAssignmentFailedException
プロセスインスタンス属性の割り当てを行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
attr - 属性
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidAttributeException - 属性が有効でない場合
AttributeAssignmentFailedException - 属性の割り当てに失敗した場合

getActivityStates

public ActivityState[] getActivityStates(java.lang.String session,
                                         java.lang.String pid,
                                         java.lang.String aid,
                                         Filter filter)
                                  throws InvalidSessionException,
                                         InvalidProcessInstanceException,
                                         InvalidActivityInstanceException,
                                         InvalidFilterException
指定されたアクティビティインスタンスが利用可能な状態一覧の取得を行う。 利用可能なフィルターはStateFilterのみとする。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
filter - 検索用フィルター
戻り値:
アクティビティインスタンス状態一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidActivityInstanceException - アクティビティインスタンスIDが有効でない場合
InvalidFilterException - 指定されたフィルターが有効でない場合

changeActivityState

public void changeActivityState(java.lang.String session,
                                java.lang.String pid,
                                java.lang.String aid,
                                ActivityState state)
                         throws InvalidSessionException,
                                InvalidProcessInstanceException,
                                InvalidActivityInstanceException,
                                InvalidStateException,
                                TransitionNotAllowedException
アクティビティインスタンス状態の変更を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
state - アクティビティインスタンス状態
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidActivityInstanceException - アクティビティインスタンスIDが有効でない場合
InvalidStateException - 指定された状態が有効でない場合
TransitionNotAllowedException - 状態の変更が許可されていない場合

getActivityAttributes

public Attribute[] getActivityAttributes(java.lang.String session,
                                         java.lang.String pid,
                                         java.lang.String aid,
                                         Filter filter)
                                  throws InvalidSessionException,
                                         InvalidProcessInstanceException,
                                         InvalidActivityInstanceException,
                                         InvalidFilterException
アクティビティインスタンス属性一覧の取得を行う。 利用可能なフィルターはNameFilter, AttributeFilter, GroupFilterとする。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
filter - 検索用フィルター
戻り値:
アクティビティインスタンス属性一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidActivityInstanceException - アクティビティインスタンスIDが有効でない場合
InvalidFilterException - 指定されたフィルターが有効でない場合

getActivityAttributeValue

public Attribute getActivityAttributeValue(java.lang.String session,
                                           java.lang.String pid,
                                           java.lang.String aid,
                                           java.lang.String name)
                                    throws InvalidSessionException,
                                           InvalidAttributeException
アクティビティインスタンス属性の属性値の取得を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
name - 属性名
戻り値:
属性
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidAttributeException - 属性が有効でない場合

assignActivityAttribute

public void assignActivityAttribute(java.lang.String session,
                                    java.lang.String pid,
                                    java.lang.String aid,
                                    Attribute attr)
                             throws InvalidSessionException,
                                    InvalidProcessInstanceException,
                                    InvalidActivityInstanceException,
                                    InvalidAttributeException,
                                    AttributeAssignmentFailedException
アクティビティインスタンス属性の割り当てを行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
attr - 属性
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidActivityInstanceException - アクティビティインスタンスIDが有効でない場合
InvalidAttributeException - 属性が有効でない場合
AttributeAssignmentFailedException - 属性の割り当てに失敗した場合

getProcesses

public Process[] getProcesses(java.lang.String session,
                              Filter filter)
                       throws InvalidSessionException,
                              InvalidFilterException
プロセスインスタンス一覧の取得を行う。 利用可能なフィルターはNameFilter, StateFilter、GroupFilterとする。

パラメータ:
session - セッションID
filter - 検索用フィルター
戻り値:
プロセスの一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidFilterException - 指定されたフィルターが有効でない場合

getProcess

public Process getProcess(java.lang.String session,
                          java.lang.String pid)
                   throws InvalidSessionException,
                          InvalidProcessInstanceException
プロセスインスタンスの取得を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
戻り値:
プロセスインスタンス
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合

getActivities

public Activity[] getActivities(java.lang.String session,
                                Filter filter)
                         throws InvalidSessionException,
                                InvalidFilterException
アクティビティインスタンス一覧の取得を行う。 利用可能なフィルターはAttributeFilter, StateFilter、GroupFilterとする。

パラメータ:
session - セッションID
filter - 検索用フィルター
戻り値:
アクティビティインスタンス一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidFilterException - 指定されたフィルターが有効でない場合

getActivities

public Activity[] getActivities(java.lang.String session,
                                java.lang.String pid,
                                Filter filter)
                         throws InvalidSessionException,
                                InvalidFilterException
アクティビティインスタンス一覧の取得を行う。 利用可能なフィルターはAttributeFilter, StateFilter、GroupFilterとする。 WfMC仕様ではpidはないが、これは誤りであろうと判断し、 pidを引数に追加した。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
filter - 検索用フィルター
戻り値:
アクティビティインスタンス一覧
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidFilterException - 指定されたフィルターが有効でない場合

getActivity

public Activity getActivity(java.lang.String session,
                            java.lang.String pid,
                            java.lang.String aid)
                     throws InvalidSessionException,
                            InvalidProcessInstanceException,
                            InvalidActivityInstanceException
アクティビティインスタンスの取得を行う。

パラメータ:
session - セッションID
pid - プロセスインスタンスID
aid - アクティビティインスタンスID
戻り値:
アクティビティインスタンス
例外:
InvalidSessionException - 指定されたセッションが無効の場合
InvalidProcessInstanceException - プロセスインスタンスIDが有効でない場合
InvalidActivityInstanceException - アクティビティインスタンスIDが有効でない場合

株式会社アルゴ21


Copyright 2005 株式会社アルゴ21