nablarch.integration.workflow

Class WorkflowInstance.CompletedWorkflowInstance

java.lang.Object

nablarch.integration.workflow.WorkflowInstanceSupport

nablarch.integration.workflow.WorkflowInstance.CompletedWorkflowInstance

All Implemented Interfaces:

WorkflowInstance

Enclosing interface:

WorkflowInstance

public static final class WorkflowInstance.CompletedWorkflowInstance
extends WorkflowInstanceSupport

完了状態のワークフローインスタンス。

本クラスでは、 WorkflowInstance が、 WorkflowInstance.completeUserTask(Map, String) や WorkflowInstance.completeGroupTask(Map, String) で完了状態になった場合と同様に振舞うワークフローインスタンスを実装している。

すなわち、 isCompleted() は常に true を返却し、 isActive(String) は常に false を返却する。 また、完了状態のワークフローインスタンスに対して許されない操作については、 IllegalStateException を送出する。 ただし、 getWorkflowId(), getVersion() については、取得することができないため、 UnsupportedOperationException を送出する。

Since:

1.4.2

Nested Class Summary

Nested classes/interfaces inherited from interface nablarch.integration.workflow.WorkflowInstance

WorkflowInstance.CompletedWorkflowInstance

Constructor Summary

Constructors

Constructor and Description
CompletedWorkflowInstance(java.lang.String instanceId) インスタンスIDを指定して、完了状態のワークフローインスタンスを生成する。

Method Summary

Modifier and Type	Method and Description
void	assignGroups(java.lang.String taskId, java.util.List<java.lang.String> groups) タスクに担当グループを割り当てる。マルチインスタンスでないタスクに対しては、複数グループを割り当てることは出来ない。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当グループの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当ユーザのみが有効となる。
void	assignGroupsToLane(java.lang.String laneId, java.util.List<java.lang.String> groups) レーンIDで指定されたレーンに属するすべてのタスクに、指定された担当グループを割り当てる。
void	assignUsers(java.lang.String taskId, java.util.List<java.lang.String> users) タスクに担当ユーザを割り当てる。マルチインスタンスでないタスクに対しては、複数ユーザを割り当てることは出来ない。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当ユーザの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当ユーザのみが有効となる。
void	assignUsersToLane(java.lang.String laneId, java.util.List<java.lang.String> users) レーンIDで指定されたレーンに属するすべてのタスクに、指定された担当ユーザを割り当てる。
void	changeAssignedGroup(java.lang.String taskId, java.lang.String oldGroup, java.lang.String newGroup) タスクに現在アサインされている担当グループを、別の担当グループに振り替える。 指定されたタスクがアクティブである場合は、アクティブグループタスクについても振り替えを行う。
void	changeAssignedUser(java.lang.String taskId, java.lang.String oldUser, java.lang.String newUser) タスクに現在アサインされている担当ユーザを、別の担当ユーザに振り替える。 指定されたタスクがアクティブタスクの場合は、アクティブユーザタスクについても振り替えを行う。
void	completeGroupTask(java.util.Map<java.lang.String,?> parameter, java.lang.String assigned) アクティブグループタスクを完了させた後、ワークフロー定義に従ってワークフローを進行させ、ワークフローインスタンスのアクティブフローノードを次のタスク もしくは停止イベントに進行させる。
void	completeUserTask(java.util.Map<java.lang.String,?> parameter, java.lang.String assigned) アクティブユーザタスクを完了させた後、ワークフロー定義に従ってワークフローを進行させ、ワークフローインスタンスのアクティブフローノードを次のタスク もしくは停止イベントに進行させる。
java.util.List<java.lang.String>	getAssignedGroups(java.lang.String taskId) タスクに割り当てられた担当グループを取得する。 担当グループは、実行順でソートされて返却される。
java.util.List<java.lang.String>	getAssignedUsers(java.lang.String taskId) タスクに割り当てられた担当ユーザを取得する。 担当ユーザは、実行順でソートされて返却される。
java.lang.String	getInstanceId() 現在のワークフローインスタンスのインスタンスIDを取得する。
long	getVersion() バージョン番号を取得する。
java.lang.String	getWorkflowId() ワークフローIDを取得する。
boolean	hasActiveGroupTask(java.lang.String group) 指定されたグループのアクティブグループタスクが存在するかどうかを確認する。
boolean	hasActiveUserTask(java.lang.String user) 指定されたユーザのアクティブユーザタスクが存在するかどうかを確認する。
boolean	isActive(java.lang.String flowNodeId) 指定されたフローノードIDがアクティブな状態かどうかを判定する。
boolean	isCompleted() ワークフローが完了状態かどうかを判定する。
java.lang.String	toString()
void	triggerEvent(java.lang.String eventTriggerId, java.util.Map<java.lang.String,?> parameter) アクティブフローノードから、境界イベントトリガーIDに対応する境界イベントを取得し、現在のタスクを中断して、境界イベントから取得される進行先フローノードに ワークフローを進行させる。

Methods inherited from class nablarch.integration.workflow.WorkflowInstanceSupport

assignGroup, assignGroupToLane, assignUser, assignUserToLane, completeGroupTask, completeUserTask, completeUserTask, completeUserTask, triggerEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompletedWorkflowInstance

public CompletedWorkflowInstance(java.lang.String instanceId)

インスタンスIDを指定して、完了状態のワークフローインスタンスを生成する。

Parameters:

instanceId - インスタンスID

Method Detail

isActive

public boolean isActive(java.lang.String flowNodeId)

指定されたフローノードIDがアクティブな状態かどうかを判定する。

完了状態のワークフローインスタンスには、アクティブフローノードは存在しないため、常に false を返却する。

Parameters:

flowNodeId - フローノードID

Returns:

アクティブな場合はtrue

isCompleted

public boolean isCompleted()

ワークフローが完了状態かどうかを判定する。

完了状態のワークフローインスタンスでは、常に true を返却する。

Returns:

ワークフローが完了している場合は true

hasActiveUserTask

public boolean hasActiveUserTask(java.lang.String user)

指定されたユーザのアクティブユーザタスクが存在するかどうかを確認する。

完了状態のワークフローインスタンスには、アクティブユーザタスクは存在しないため、常に false を返却する。

Parameters:

user - ユーザ

Returns:

ユーザのアクティブユーザタスクが存在する場合は true

hasActiveGroupTask

public boolean hasActiveGroupTask(java.lang.String group)

指定されたグループのアクティブグループタスクが存在するかどうかを確認する。

完了状態のワークフローインスタンスには、アクティブグループタスクは存在しないため、常に false を返却する。

Parameters:

group - グループ

Returns:

グループのアクティブグループタスクが存在する場合は true

getAssignedUsers

public java.util.List<java.lang.String> getAssignedUsers(java.lang.String taskId)
                                                  throws java.lang.IllegalArgumentException

タスクに割り当てられた担当ユーザを取得する。

担当ユーザは、実行順でソートされて返却される。

完了状態のワークフローインスタンスでは、対象タスクに割り当てられていた担当ユーザを取得できないため、常に空のリストを返却する。

Parameters:

taskId - タスクID

Returns:

担当ユーザ

Throws:

java.lang.IllegalArgumentException - 指定されたタスクがワークフロー定義に存在しない場合

getAssignedGroups

public java.util.List<java.lang.String> getAssignedGroups(java.lang.String taskId)
                                                   throws java.lang.IllegalArgumentException

タスクに割り当てられた担当グループを取得する。

担当グループは、実行順でソートされて返却される。

完了状態のワークフローインスタンスでは、対象タスクに割り当てられていた担当グループを取得できないため、常に空のリストを返却する。

Parameters:

taskId - タスクID

Returns:

担当グループ

Throws:

java.lang.IllegalArgumentException - 指定されたタスクがワークフロー定義に存在しない場合

getInstanceId

public java.lang.String getInstanceId()

Description copied from interface: WorkflowInstance

現在のワークフローインスタンスのインスタンスIDを取得する。

Returns:

ワークフローインスタンスのインスタンスID

getWorkflowId

public java.lang.String getWorkflowId()

ワークフローIDを取得する。

完了状態のワークフローインスタンスでは、ワークフロー定義のワークフローIDは取得することができないため、 UnsupportedOperationException を送出する。

Returns:

ワークフローID

getVersion

public long getVersion()

バージョン番号を取得する。

完了状態のワークフローインスタンスでは、ワークフロー定義のバージョンは取得することができないため、 UnsupportedOperationException を送出する。

Returns:

バージョン番号

completeUserTask

public void completeUserTask(java.util.Map<java.lang.String,?> parameter,
                             java.lang.String assigned)
                      throws java.lang.IllegalStateException

アクティブユーザタスクを完了させた後、ワークフロー定義に従ってワークフローを進行させ、ワークフローインスタンスのアクティブフローノードを次のタスク もしくは停止イベントに進行させる。

完了状態のワークフローインスタンスに対して、タスクを進行することは出来ないため、 IllegalStateException を送出する。

Parameters:

parameter - ワークフローを進行させる際に、各フローノードで使用するパラメータ

assigned - タスクを完了させるユーザ

Throws:

java.lang.IllegalStateException - assigned に対してアクティブユーザタスクが見つからない場合、またはワークフローが既に完了している場合。

completeGroupTask

public void completeGroupTask(java.util.Map<java.lang.String,?> parameter,
                              java.lang.String assigned)
                       throws java.lang.IllegalStateException

アクティブグループタスクを完了させた後、ワークフロー定義に従ってワークフローを進行させ、ワークフローインスタンスのアクティブフローノードを次のタスク もしくは停止イベントに進行させる。

完了状態のワークフローインスタンスに対して、タスクを進行することは出来ないため、 IllegalStateException を送出する。

Parameters:

parameter - ワークフローを進行させる際に、各フローノードで使用するパラメータ

assigned - タスクを完了させるグループ

Throws:

java.lang.IllegalStateException - assigned に対してアクティブグループタスクが見つからない場合、またはワークフローが既に完了している場合。

triggerEvent

public void triggerEvent(java.lang.String eventTriggerId,
                         java.util.Map<java.lang.String,?> parameter)
                  throws java.lang.IllegalStateException

アクティブフローノードから、境界イベントトリガーIDに対応する境界イベントを取得し、現在のタスクを中断して、境界イベントから取得される進行先フローノードに ワークフローを進行させる。

完了状態のワークフローインスタンスに対して、境界イベントを発生させることは出来ないため、 IllegalStateException を送出する。

Parameters:

eventTriggerId - 境界イベントトリガーID

parameter - ワークフローを進行させる際に利用するパラメータ

Throws:

java.lang.IllegalStateException - アクティブフローノードから、境界イベントトリガーIDに対応する境界イベントを取得できなかった場合。

assignUsers

public void assignUsers(java.lang.String taskId,
                        java.util.List<java.lang.String> users)
                 throws java.lang.IllegalStateException,
                        java.lang.IllegalArgumentException

タスクに担当ユーザを割り当てる。マルチインスタンスでないタスクに対しては、複数ユーザを割り当てることは出来ない。

マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当ユーザの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当ユーザのみが有効となる。

完了状態のワークフローインスタンスに対して、担当ユーザを割り当てることは出来ないため、 IllegalStateException を送出する。

Parameters:

taskId - タスクID

users - 担当ユーザリスト

Throws:

java.lang.IllegalStateException - ワークフローがすでに完了している場合

java.lang.IllegalArgumentException - 指定されたタスクが存在しない場合、もしくはマルチインスタンスでないタスクに複数ユーザを割り当てようとした場合。

assignGroups

public void assignGroups(java.lang.String taskId,
                         java.util.List<java.lang.String> groups)
                  throws java.lang.IllegalStateException,
                         java.lang.IllegalArgumentException

タスクに担当グループを割り当てる。マルチインスタンスでないタスクに対しては、複数グループを割り当てることは出来ない。

マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当グループの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当ユーザのみが有効となる。

完了状態のワークフローインスタンスに対して、担当グループを割り当てることは出来ないため、 IllegalStateException を送出する。

Parameters:

taskId - タスクのフローノードID

groups - 担当グループ

Throws:

java.lang.IllegalStateException - ワークフローがすでに完了している場合

java.lang.IllegalArgumentException - 指定されたタスクが存在しない場合、もしくはマルチインスタンスでないタスクに複数グループを割り当てようとした場合。

assignUsersToLane

public void assignUsersToLane(java.lang.String laneId,
                              java.util.List<java.lang.String> users)
                       throws java.lang.IllegalStateException,
                              java.lang.IllegalArgumentException

レーンIDで指定されたレーンに属するすべてのタスクに、指定された担当ユーザを割り当てる。

完了状態のワークフローインスタンスに対して、担当ユーザを割り当てることは出来ないため、 IllegalStateException を送出する。

Parameters:

laneId - 担当ユーザを割り当てるタスクが属するレーンのレーンID

users - 担当ユーザリスト

Throws:

java.lang.IllegalStateException - ワークフローがすでに完了している場合

java.lang.IllegalArgumentException - マルチインスタンスでないタスクに複数ユーザを割り当てようとした場合。

assignGroupsToLane

public void assignGroupsToLane(java.lang.String laneId,
                               java.util.List<java.lang.String> groups)
                        throws java.lang.IllegalStateException,
                               java.lang.IllegalArgumentException

レーンIDで指定されたレーンに属するすべてのタスクに、指定された担当グループを割り当てる。

完了状態のワークフローインスタンスに対して、担当グループを割り当てることは出来ないため、 IllegalStateException を送出する。

Parameters:

laneId - 担当ユーザを割り当てるタスクが属するレーンのレーンID

groups - 担当ユーザ

Throws:

java.lang.IllegalStateException - ワークフローがすでに完了している場合

java.lang.IllegalArgumentException - マルチインスタンスでないタスクに複数グループを割り当てようとした場合。

changeAssignedUser

public void changeAssignedUser(java.lang.String taskId,
                               java.lang.String oldUser,
                               java.lang.String newUser)
                        throws java.lang.IllegalArgumentException,
                               java.lang.IllegalStateException

タスクに現在アサインされている担当ユーザを、別の担当ユーザに振り替える。

指定されたタスクがアクティブタスクの場合は、アクティブユーザタスクについても振り替えを行う。

完了状態のワークフローインスタンスに対して、担当ユーザを振替えることは出来ないため、 IllegalStateException を送出する。

Parameters:

taskId - 担当ユーザを振り替えるタスク

oldUser - 振替元の担当ユーザ

newUser - 振替先の担当ユーザ

Throws:

java.lang.IllegalArgumentException - 指定されたタスクがワークフロー定義に存在しない場合

java.lang.IllegalStateException - 指定されたタスクに、振替元の担当ユーザがアサインされていない場合

changeAssignedGroup

public void changeAssignedGroup(java.lang.String taskId,
                                java.lang.String oldGroup,
                                java.lang.String newGroup)
                         throws java.lang.IllegalArgumentException,
                                java.lang.IllegalStateException

タスクに現在アサインされている担当グループを、別の担当グループに振り替える。

指定されたタスクがアクティブである場合は、アクティブグループタスクについても振り替えを行う。

完了状態のワークフローインスタンスに対して、担当グループを振替えることは出来ないため、 IllegalStateException を送出する。

Parameters:

taskId - 担当ユーザを振り替えるタスク

oldGroup - 振替元の担当グループ

newGroup - 振替先の担当グループ

Throws:

java.lang.IllegalArgumentException - 指定されたタスクがワークフロー定義に存在しない場合

java.lang.IllegalStateException - 指定されたタスクに、振替元の担当グループがアサインされていない場合

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object