パッケージ com.handywedge.workflow

インタフェース FWWFManager

  • public interface FWWFManager
    導入されたバージョン:
    0.5.0

    • メソッドの概要

      すべてのメソッド インスタンス・メソッド abstractメソッド 
      修飾子とタイプ メソッド 説明
      FWWFAction checkAction​(String wfId, String actionCode)
      ログイン中のユーザーが指定されたアクションを実行できるか判定します。
      FWWFLog doAction​(FWWFAction wfAction)
      ログイン中のユーザーによるWFアクションを実行します。
      FWWFLog doAction​(FWWFAction wfAction, String description)
      ログイン中のユーザーによるWFアクションを実行します。
      FWWFLog doAction​(String wfId, String actionCode)
      ログイン中のユーザーによるWFアクションを実行します。
      FWWFLog doAction​(String wfId, String actionCode, String description)
      ログイン中のユーザーによるWFアクションを実行します。
      FWWFLog doInitAction​(FWWFAction wfAction)
      ログイン中のユーザーによる初期WFアクションを実行します。
      FWWFLog doInitAction​(FWWFAction wfAction, String description)
      ログイン中のユーザーによる初期WFアクションを実行します。
      FWWFLog doInitAction​(String actionCode)
      ログイン中のユーザーによる初期WFアクションを実行します。
      FWWFLog doInitAction​(String actionCode, String description)
      ログイン中のユーザーによる初期WFアクションを実行します。
      FWWFAction getAction​(String actionCode)
      ログイン中のユーザーが実行可能な指定のアクションコードの承認アクションを（DTO）を返します。
      FWWFAction getActionInfo​(String actionCode, String role)
      指定されたロールのユーザーが実行可能な指定のアクションコードの承認アクションを（DTO）を返します。
      List<FWWFAction> getActionInfos​(String wfId, String role)
      指定されたロールのユーザーが現在のステータスに対して起こせる承認アクション、 及び、否認アクション（前ステータスに戻す）のリスト（DTO）を返します。
      List<FWWFAction> getActions​(String wfId)
      ログイン中のユーザーが現在のステータスに対して起こせる承認アクション、 及び、否認アクション（前ステータスに戻す）のリスト（DTO）を返します。
      List<FWWFAction> getGoActionInfos​(String wfId, String role)
      指定されたロールのユーザーが現在のステータスに対して起こせる承認アクション（DTO）のリストを返します。
      List<FWWFAction> getGoActions​(String wfId)
      ログイン中のユーザーが現在のステータスに対して起こせる承認アクション（DTO）のリストを返します。
      FWWFAction getRollBackAction​(String wfId)
      ログイン中のユーザーが現在のステータスに対して起こせる否認アクション（DTO）を返します。
      FWWFAction getRollBackActionInfo​(String wfId, String role)
      指定されたロールのユーザーが現在のステータスに対して起こせる否認アクション（DTO）を返します。
      FWWFStatus getStatus​(String wfId)
      指定されたWFIDの現在のステータスのDTOを返します。
      List<FWWFLog> getWFLogs​(String wfId)
      指定されたWFIDのワークフロー履歴のDTOリストを返します。

    • メソッドの詳細

      • getStatus

        FWWFStatus getStatus​(String wfId)
        指定されたWFIDの現在のステータスのDTOを返します。 ステータスが取得できなかった場合はNULLを返します。
        パラメータ:
        wfId - ワークフローID
        戻り値:
        ステータスコードとステータス名のDTO

      • getAction

        FWWFAction getAction​(String actionCode)
        ログイン中のユーザーが実行可能な指定のアクションコードの承認アクションを（DTO）を返します。
        パラメータ:
        actionCode - アクションコード
        戻り値:
        実行可能な承認アクションDTO

      • getActions

        List<FWWFAction> getActions​(String wfId)
        ログイン中のユーザーが現在のステータスに対して起こせる承認アクション、 及び、否認アクション（前ステータスに戻す）のリスト（DTO）を返します。
        パラメータ:
        wfId - ワークフローID
        戻り値:
        実行可能な承認、否認アクションDTOリスト

      • getGoActions

        List<FWWFAction> getGoActions​(String wfId)
        ログイン中のユーザーが現在のステータスに対して起こせる承認アクション（DTO）のリストを返します。
        パラメータ:
        wfId - ワークフローID
        戻り値:
        実行可能な承認アクションDTOリスト

      • getRollBackAction

        FWWFAction getRollBackAction​(String wfId)
        ログイン中のユーザーが現在のステータスに対して起こせる否認アクション（DTO）を返します。 否認アクションは１つ前のステータスに戻すアクションを指す。
        パラメータ:
        wfId - ワークフローID
        戻り値:
        実行可能な否認系アクションDTOリスト

      • getActionInfo

        FWWFAction getActionInfo​(String actionCode,
                         String role)
        指定されたロールのユーザーが実行可能な指定のアクションコードの承認アクションを（DTO）を返します。
        パラメータ:
        actionCode - アクションコード
        role - ロール
        戻り値:
        実行可能な承認アクションDTO

      • getActionInfos

        List<FWWFAction> getActionInfos​(String wfId,
                                String role)
        指定されたロールのユーザーが現在のステータスに対して起こせる承認アクション、 及び、否認アクション（前ステータスに戻す）のリスト（DTO）を返します。
        パラメータ:
        wfId - ワークフローID
        role - ロール
        戻り値:
        実行可能な承認、否認アクションDTOリスト

      • getGoActionInfos

        List<FWWFAction> getGoActionInfos​(String wfId,
                                  String role)
        指定されたロールのユーザーが現在のステータスに対して起こせる承認アクション（DTO）のリストを返します。
        パラメータ:
        wfId - ワークフローID
        role - ロール
        戻り値:
        実行可能な承認アクションDTOリスト

      • getRollBackActionInfo

        FWWFAction getRollBackActionInfo​(String wfId,
                                 String role)
        指定されたロールのユーザーが現在のステータスに対して起こせる否認アクション（DTO）を返します。 否認アクションは１つ前のステータスに戻すアクションを指す。
        パラメータ:
        wfId - ワークフローID
        role - ロール
        戻り値:
        実行可能な否認系アクションDTOリスト

      • checkAction

        FWWFAction checkAction​(String wfId,
                       String actionCode)
                throws FWWFException
        ログイン中のユーザーが指定されたアクションを実行できるか判定します。 権限を持つ場合は該当アクションのアクションコードとアクション名が設定されたDTOを返します。 権限がない場合は例外がスローされます。 ※ ワークフローID採番後のみ使用
        パラメータ:
        wfId - ワークフローID
        actionCode - 実行対象のアクションコード
        戻り値:
        アクションコードとアクション名のDTO
        例外:
        FWWFException - 権限がない場合にスロー

      • doInitAction

        FWWFLog doInitAction​(String actionCode)
              throws FWWFException
        ログイン中のユーザーによる初期WFアクションを実行します。 初期WFアクションとはワークフローの開始アクションを指し、WFIDの採番を行い返却します。 以後のアクションはWFIDを指定することで一連のWFの紐付け実行が可能です。
        パラメータ:
        actionCode - 実行対象のアクションコード
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doInitAction

        FWWFLog doInitAction​(String actionCode,
                     String description)
              throws FWWFException
        ログイン中のユーザーによる初期WFアクションを実行します。 初期WFアクションとはワークフローの開始アクションを指し、WFIDの採番を行い返却します。 以後のアクションはWFIDを指定することで一連のWFの紐付け実行が可能です。
        パラメータ:
        actionCode - 実行対象のアクションコード
        description - ワークフロー履歴-備考
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doInitAction

        FWWFLog doInitAction​(FWWFAction wfAction)
              throws FWWFException
        ログイン中のユーザーによる初期WFアクションを実行します。 初期WFアクションとはワークフローの開始アクションを指し、WFIDの採番を行い返却します。 以後のアクションはWFIDを指定することで一連のWFの紐付け実行が可能です。
        パラメータ:
        wfAction - 実行対象のアクションオブジェクト（actionCodeの指定必須）
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doInitAction

        FWWFLog doInitAction​(FWWFAction wfAction,
                     String description)
              throws FWWFException
        ログイン中のユーザーによる初期WFアクションを実行します。 初期WFアクションとはワークフローの開始アクションを指し、WFIDの採番を行い返却します。 以後のアクションはWFIDを指定することで一連のWFの紐付け実行が可能です。
        パラメータ:
        wfAction - 実行対象のアクションオブジェクト（actionCodeの指定必須）
        description - ワークフロー履歴-備考
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doAction

        FWWFLog doAction​(String wfId,
                 String actionCode)
          throws FWWFException
        ログイン中のユーザーによるWFアクションを実行します。
        パラメータ:
        wfId - ワークフローID
        actionCode - 実行対象のアクションコード
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doAction

        FWWFLog doAction​(String wfId,
                 String actionCode,
                 String description)
          throws FWWFException
        ログイン中のユーザーによるWFアクションを実行します。
        パラメータ:
        wfId - ワークフローID
        actionCode - 実行対象のアクションコード
        description - ワークフロー履歴-備考
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doAction

        FWWFLog doAction​(FWWFAction wfAction)
          throws FWWFException
        ログイン中のユーザーによるWFアクションを実行します。
        パラメータ:
        wfAction - 実行対象のアクションオブジェクト（wfId, actionCodeの指定必須）
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • doAction

        FWWFLog doAction​(FWWFAction wfAction,
                 String description)
          throws FWWFException
        ログイン中のユーザーによるWFアクションを実行します。
        パラメータ:
        wfAction - 実行対象のアクションオブジェクト（wfId, actionCodeの指定必須）
        description - ワークフロー履歴-備考
        戻り値:
        ワークフロー履歴のDTOリスト
        例外:
        FWWFException - 権限がない場合にスロー

      • getWFLogs

        List<FWWFLog> getWFLogs​(String wfId)
        指定されたWFIDのワークフロー履歴のDTOリストを返します。
        パラメータ:
        wfId - ワークフローID
        戻り値:
        ワークフロー履歴のDTOリスト