概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| Nautica Workflow
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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

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

public interface WorkItemHandler

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

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

メソッドの概要
`void` | `assignWorkItemAttribute(java.lang.String session, java.lang.String wid, Attribute attr)` 作業項目属性の割り当てを行う。
`void` | `changeWorkItemState(java.lang.String session, java.lang.String wid, WorkItemState state)` 作業項目状態の変更を行う。
`void` | `completeWorkItem(java.lang.String session, java.lang.String wid)` 作業項目の完了を行う。
`WorkItem` | `getWorkItem(java.lang.String session, java.lang.String wid)` 作業項目の取得を行う。
`Attribute[]` | `getWorkItemAttributes(java.lang.String session, java.lang.String wid, Filter filter)` 作業項目属性一覧の取得を行う。
`Attribute` | `getWorkItemAttributeValue(java.lang.String session, java.lang.String wid, java.lang.String name)` 作業項目属性の取得を行う。
`WorkItem[]` | `getWorkItems(java.lang.String session, Filter filter)` 作業項目一覧の取得を行う。
`WorkItemState[]` | `getWorkItemStates(java.lang.String session, java.lang.String wid, Filter filter)` 現在の作業項目が遷移可能な状態の一覧を返す。
`void` | `reassignWorkItem(java.lang.String session, Participant sourceUser, Participant targetUser, java.lang.String wid)` 作業項目の再割り当てを行う。

メソッドの詳細

### getWorkItems

    public WorkItem[] getWorkItems(java.lang.String session,
                                   Filter filter)
                            throws InvalidSessionException,
                                   InvalidFilterException

  作業項目一覧の取得を行う。

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

### getWorkItem

    public WorkItem getWorkItem(java.lang.String session,
                                java.lang.String wid)
                         throws InvalidSessionException,
                                InvalidWorkItemException

  作業項目の取得を行う。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
  戻り値:
    作業項目
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合

### completeWorkItem

    public void completeWorkItem(java.lang.String session,
                                 java.lang.String wid)
                          throws InvalidSessionException,
                                 InvalidWorkItemException

  作業項目の完了を行う。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合

### getWorkItemStates

    public WorkItemState[] getWorkItemStates(java.lang.String session,
                                             java.lang.String wid,
                                             Filter filter)
                                      throws InvalidSessionException,
                                             InvalidWorkItemException,
                                             InvalidFilterException

  現在の作業項目が遷移可能な状態の一覧を返す。 状態がない場合は、空の配列を返す。 利用可能なフィルターはStateFilterのみとする。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
    `filter` - 検索用フィルター
  戻り値:
    作業項目状態一覧
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidFilterException` - 指定されたフィルターが有効でない場合

### changeWorkItemState

    public void changeWorkItemState(java.lang.String session,
                                    java.lang.String wid,
                                    WorkItemState state)
                             throws InvalidSessionException,
                                    InvalidWorkItemException,
                                    InvalidStateException,
                                    TransitionNotAllowedException

  作業項目状態の変更を行う。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
    `state` - 作業項目状態
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidStateException` - 指定された状態が有効でない場合
    `TransitionNotAllowedException` - 状態の変更が許可されていない場合

### reassignWorkItem

    public void reassignWorkItem(java.lang.String session,
                                 Participant sourceUser,
                                 Participant targetUser,
                                 java.lang.String wid)
                          throws InvalidSessionException,
                                 InvalidWorkItemException,
                                 InvalidSourceUserException,
                                 InvalidTargetUserException

  作業項目の再割り当てを行う。

  パラメータ:
    `session` - セッションID
    `sourceUser` - 割り当て前のユーザ
    `targetUser` - 割り当て後のユーザ
    `wid` - 作業項目ID
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidSourceUserException` - 割り当て前ユーザが有効でない場合
    `InvalidTargetUserException` - 割り当て先ユーザが有効でない場合

### getWorkItemAttributes

    public Attribute[] getWorkItemAttributes(java.lang.String session,
                                             java.lang.String wid,
                                             Filter filter)
                                      throws InvalidSessionException,
                                             InvalidWorkItemException,
                                             InvalidFilterException

  作業項目属性一覧の取得を行う。 利用可能なフィルターはNameFilter, AttributeFilter, GroupFilterとする。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
    `filter` - 検索用フィルター
  戻り値:
    作業項目属性一覧
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidFilterException` - 指定されたフィルターが有効でない場合

### getWorkItemAttributeValue

    public Attribute getWorkItemAttributeValue(java.lang.String session,
                                               java.lang.String wid,
                                               java.lang.String name)
                                        throws InvalidSessionException,
                                               InvalidWorkItemException,
                                               InvalidAttributeException

  作業項目属性の取得を行う。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
    `name` - 属性名
  戻り値:
    属性
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidAttributeException` - 属性が有効でない場合

### assignWorkItemAttribute

    public void assignWorkItemAttribute(java.lang.String session,
                                        java.lang.String wid,
                                        Attribute attr)
                                 throws InvalidSessionException,
                                        InvalidWorkItemException,
                                        InvalidAttributeException,
                                        AttributeAssignmentFailedException

  作業項目属性の割り当てを行う。

  パラメータ:
    `session` - セッションID
    `wid` - 作業項目ID
    `attr` - 属性
  例外:
    `InvalidSessionException` - 指定されたセッションが無効の場合
    `InvalidWorkItemException` - 作業項目IDが有効でない場合
    `InvalidAttributeException` - 属性が有効でない場合
    `AttributeAssignmentFailedException` - 属性の割り当てに失敗した場合

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| 株式会社アルゴ２１
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright 2005 株式会社アルゴ２１