nablarch.integration.workflow.definition

Class Task

java.lang.Object

nablarch.integration.workflow.definition.FlowNode

nablarch.integration.workflow.definition.Task

public class Task
extends FlowNode

タスク定義を表すクラス。

Since:

1.4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.MultiInstanceType マルチインスタンスタイプを表す列挙型。

Constructor Summary

Constructors

Constructor and Description
Task(java.lang.String flowNodeId, java.lang.String flowNodeName, java.lang.String laneId, java.lang.String multiInstanceType, java.lang.String completionCondition, java.util.List<SequenceFlow> sequenceFlows) タスク定義を生成する。

Method Summary

Modifier and Type	Method and Description
void	activate(java.lang.String instanceId, java.util.Map<java.lang.String,?> parameter) フローノードのアクティブ化処理を行う。
void	assignGroups(java.lang.String instanceId, java.util.List<java.lang.String> groups) タスクに担当グループを割り当てる。マルチインスタンスでないタスクに対しては、複数グループを割り当てることは出来ない。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当グループの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当グループのみが有効となる。
void	assignUsers(java.lang.String instanceId, java.util.List<java.lang.String> users) タスクに担当ユーザを割り当てる。マルチインスタンスでないタスクに対しては、複数ユーザを割り当てることは出来ない。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、指定された担当ユーザの順序がタスクの実行順となる。 すでにタスクに担当ユーザや担当グループが割り当てられている場合、それらの情報はクリアされ、今回設定した担当ユーザのみが有効となる。
void	changeActiveGroupTask(java.lang.String instanceId, java.lang.String oldGroup, java.lang.String newGroup) 現在のアクティブグループタスクのうち、 oldGroup に指定されたグループのタスクを、 newGroup のタスクに更新する。 oldGroup のアクティブグループタスクが見つからない場合には、何も処理を行わない。
void	changeActiveUserTask(java.lang.String instanceId, java.lang.String oldUser, java.lang.String newUser) 現在のアクティブユーザタスクのうち、 oldUser に指定されたユーザのタスクを、 newUser のタスクに更新する。 oldUser のアクティブユーザタスクが見つからない場合には、何も処理を行わない。
void	changeAssignedGroup(java.lang.String instanceId, java.lang.String oldGroup, java.lang.String newGroup) タスクに現在アサインされている担当グループを、別の担当グループに振り替える。
void	changeAssignedUser(java.lang.String instanceId, java.lang.String oldUser, java.lang.String newUser) タスクに現在アサインされている担当ユーザを、別の担当ユーザに振り替える。
java.util.List<java.lang.String>	getAssignedGroups(java.lang.String instanceId) タスクに割り当てられた担当グループを取得する。 担当グループは、実行順でソートされて返却される。
java.util.List<java.lang.String>	getAssignedUsers(java.lang.String instanceId) タスクに割り当てられた担当ユーザを取得する。 担当ユーザは、実行順でソートされて返却される。
Task.MultiInstanceType	getMultiInstanceType() マルチインスタンスタイプを取得する。
boolean	isMultiInstanceType() マルチインスタンスタスクか否か。
boolean	isSequentialType() マルチインスタンスタスクでシーケンシャルタイプか否か
boolean	processNodeByGroup(java.lang.String instanceId, java.util.Map<java.lang.String,?> parameter, java.lang.String executor) グループタスクとして、フローノード上での処理を行う。フローノードでの処理が完了し、ワークフローを次のノードに進めてよい場合は true を返却する。
boolean	processNodeByUser(java.lang.String instanceId, java.util.Map<java.lang.String,?> parameter, java.lang.String executor) ユーザタスクとして、フローノード上での処理を行う。フローノードでの処理が完了し、ワークフローを次のノードに進めてよい場合は true を返却する。
void	refreshActiveGroupTasks(java.lang.String instanceId, java.util.List<java.lang.String> groups) アクティブタスクを、指定された担当グループのタスクに置き換える。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、割り当てられている担当グループのうち実行順が先頭の担当グループの アクティブタスクが作成される。それ以外の場合は、割り当てられているすべての担当グループのアクティブタスクが作成される。
void	refreshActiveUserTasks(java.lang.String instanceId, java.util.List<java.lang.String> users) アクティブタスクを、現在このタスクに割り当てられている担当ユーザのタスクに置き換える。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、割り当てられている担当ユーザのうち実行順が先頭の担当ユーザの アクティブタスクが作成される。それ以外の場合は、割り当てられているすべての担当ユーザのアクティブタスクが作成される。

Methods inherited from class nablarch.integration.workflow.definition.FlowNode

getFlowNodeId, getFlowNodeName, getLaneId, getNextFlowNodeId, getSequenceFlows, getWorkflowInstanceDao

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(java.lang.String flowNodeId,
            java.lang.String flowNodeName,
            java.lang.String laneId,
            java.lang.String multiInstanceType,
            java.lang.String completionCondition,
            java.util.List<SequenceFlow> sequenceFlows)

タスク定義を生成する。

Parameters:

flowNodeId - フローノードID

flowNodeName - フローノード名

laneId - レーンID

multiInstanceType - マルチインスタンスタイプ

completionCondition - 終了条件の型名

sequenceFlows - 自身をソースとするシーケンスフロー

Method Detail

getMultiInstanceType

public Task.MultiInstanceType getMultiInstanceType()

マルチインスタンスタイプを取得する。

Returns:

マルチインスタンスタイプ

isMultiInstanceType

public boolean isMultiInstanceType()

マルチインスタンスタスクか否か。

Returns:

マルチインスタンスタスクの場合はtrue

isSequentialType

public boolean isSequentialType()

マルチインスタンスタスクでシーケンシャルタイプか否か

Returns:

マルチインスタンスタスクで、シーケンシャルタイプの場合はtrue

activate

public void activate(java.lang.String instanceId,
                     java.util.Map<java.lang.String,?> parameter)

フローノードのアクティブ化処理を行う。

このタスクをアクティブフローノードに登録し、タスク担当ユーザ/グループから、アクティブユーザタスク/アクティブグループタスクを作成する。 マルチインスタンスタスクで、シーケンシャルタイプの場合は、タスク担当ユーザ/グループのうち実行順が先頭のユーザ/グループのアクティブタスクを作成し、 それ以外の場合は、すべてのユーザ/グループのアクティブタスクを作成する。

Overrides:

activate in class FlowNode

Parameters:

instanceId - アクティブ化処理を行う対象のワークフローインスタンスID

parameter - アクティブ化時に使用するパラメータ

processNodeByUser

public boolean processNodeByUser(java.lang.String instanceId,
                                 java.util.Map<java.lang.String,?> parameter,
                                 java.lang.String executor)
                          throws java.lang.IllegalStateException

ユーザタスクとして、フローノード上での処理を行う。フローノードでの処理が完了し、ワークフローを次のノードに進めてよい場合は true を返却する。

executor に指定されたユーザのアクティブタスクを完了させ、シーケンシャルタイプの場合は、実行順が次のユーザのアクティブタスクを作成する。 その後、 CompletionCondition.isCompletedUserTask(Map, String, Task) を評価してその結果を返却する。

Overrides:

processNodeByUser in class FlowNode

Parameters:

instanceId - 対象のワークフローインスタンスID

parameter - ワークフローの進行時に使用するパラメータ

executor - このノードでの処理を実行しているユーザ

Returns:

次のフローノードにワークフローを進行させて良い場合は true

Throws:

java.lang.IllegalStateException - 指定された実行ユーザのアクティブタスクが存在しない場合

processNodeByGroup

public boolean processNodeByGroup(java.lang.String instanceId,
                                  java.util.Map<java.lang.String,?> parameter,
                                  java.lang.String executor)
                           throws java.lang.IllegalStateException

グループタスクとして、フローノード上での処理を行う。フローノードでの処理が完了し、ワークフローを次のノードに進めてよい場合は true を返却する。

executor に指定されたグループのアクティブタスクを完了させ、シーケンシャルタイプの場合は、実行順が次のグループのアクティブタスクを作成する。 その後、 CompletionCondition.isCompletedGroupTask(Map, String, Task) を評価してその結果を返却する。

Overrides:

processNodeByGroup in class FlowNode

Parameters:

instanceId - 対象のワークフローインスタンスID

parameter - ワークフローの進行時に使用するパラメータ

executor - このノードでの処理を実行しているグループ

Returns:

次のフローノードにワークフローを進行させて良い場合は true

Throws:

java.lang.IllegalStateException - 指定された実行グループのアクティブタスクが存在しない場合

assignUsers

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

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

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

Parameters:

instanceId - ワークフローインスタンスID

users - 担当ユーザリスト

Throws:

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

refreshActiveUserTasks

public void refreshActiveUserTasks(java.lang.String instanceId,
                                   java.util.List<java.lang.String> users)

アクティブタスクを、現在このタスクに割り当てられている担当ユーザのタスクに置き換える。

マルチインスタンスタスクで、シーケンシャルタイプの場合は、割り当てられている担当ユーザのうち実行順が先頭の担当ユーザの アクティブタスクが作成される。それ以外の場合は、割り当てられているすべての担当ユーザのアクティブタスクが作成される。

Parameters:

instanceId - ワークフローインスタンスID

users - 担当ユーザリスト

assignGroups

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

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

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

Parameters:

instanceId - ワークフローインスタンスID

groups - 担当グループリスト

Throws:

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

refreshActiveGroupTasks

public void refreshActiveGroupTasks(java.lang.String instanceId,
                                    java.util.List<java.lang.String> groups)

アクティブタスクを、指定された担当グループのタスクに置き換える。

マルチインスタンスタスクで、シーケンシャルタイプの場合は、割り当てられている担当グループのうち実行順が先頭の担当グループの アクティブタスクが作成される。それ以外の場合は、割り当てられているすべての担当グループのアクティブタスクが作成される。

Parameters:

instanceId - ワークフローインスタンスID

groups - 担当グループリスト

changeAssignedUser

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

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

Parameters:

instanceId - 対象のワークフローのインスタンスID

oldUser - 振替元の担当ユーザ

newUser - 振替先の担当ユーザ

Throws:

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

changeActiveUserTask

public void changeActiveUserTask(java.lang.String instanceId,
                                 java.lang.String oldUser,
                                 java.lang.String newUser)

現在のアクティブユーザタスクのうち、 oldUser に指定されたユーザのタスクを、 newUser のタスクに更新する。

oldUser のアクティブユーザタスクが見つからない場合には、何も処理を行わない。

Parameters:

instanceId - 対象のワークフローのインスタンスID

oldUser - 振替元の担当ユーザ

newUser - 振替先の担当ユーザ

changeAssignedGroup

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

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

Parameters:

instanceId - 対象のワークフローのインスタンスID

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

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

Throws:

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

changeActiveGroupTask

public void changeActiveGroupTask(java.lang.String instanceId,
                                  java.lang.String oldGroup,
                                  java.lang.String newGroup)

現在のアクティブグループタスクのうち、 oldGroup に指定されたグループのタスクを、 newGroup のタスクに更新する。

oldGroup のアクティブグループタスクが見つからない場合には、何も処理を行わない。

Parameters:

instanceId - 対象のワークフローのインスタンスID

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

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

getAssignedUsers

public java.util.List<java.lang.String> getAssignedUsers(java.lang.String instanceId)

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

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

Parameters:

instanceId - 対象のワークフローのインスタンスID

Returns:

担当ユーザ

getAssignedGroups

public java.util.List<java.lang.String> getAssignedGroups(java.lang.String instanceId)

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

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

Parameters:

instanceId - 対象のワークフローのインスタンスID

Returns:

担当グループ