/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     boss_TaskPolicy.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 31623 $
 *---------------------------------------------------------------------------*/

#ifndef NN_BOSS_BOSS_TASK_POLICY_H_
#define NN_BOSS_BOSS_TASK_POLICY_H_

#include <nn/boss/boss_Const.h>
#include <nn/boss/boss_Result.h>
#include <nn/boss/boss_Types.h>

#ifdef __cplusplus

namespace nn {
namespace boss {

/*!
  @brief        タスクポリシーを表すクラスです。タスクを登録する際のポリシー情報設定などに利用します。
*/
class TaskPolicy
{
public:
/*!
  @brief        コンストラクタです。
*/
    explicit TaskPolicy(void);

/*!
  @brief        デストラクタです。
*/
    virtual ~TaskPolicy(void);

/*!
  @brief        ポリシーの設定を行います。この初期化にとってオブジェクトの再利用が可能になります。
  @param[in]    interval    タスクの実行間隔を指定します。単位は時間です。（1時間～168時間が利用できる有効な範囲です。）
  @param[in]    count       タスクの実行回数を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       初期化に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    inline nn::Result Initialize(u32 interval, u32 count){return InitializeWithSecInterval(interval*60*60, count);}

    /*!
      @brief        [デバッグ専用。正規の実行間隔は時間単位でしか許可されませんので、デバッグ以外では @ref Initialize を利用してください。]ポリシーの設定を行います。実行間隔は秒単位で指定します。

      （1秒～168時間が利用できる有効な範囲です。）

      @param[in]    intervalSec タスクの実行間隔を指定します。単位は秒です。
      @param[in]    count       タスクの実行回数を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       初期化に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
    */
    nn::Result InitializeWithSecInterval(u32 intervalSec, u32 count);

/*!
  @brief        ポリシーの設定を行います。
  @param[in]    priority    タスク実行の優先度を指定します。
  @param[in]    interval    タスクの実行間隔を指定します。単位は時間です。（1時間～168時間が利用できる有効な範囲です。）
  @param[in]    count       タスクの実行回数を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       初期化に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    inline nn::Result Initialize(TaskPriority priority, u32 interval, u32 count){return InitializeWithSecInterval(priority, interval*60*60, count);}

/*!
  @brief        [デバッグ専用。正規の実行間隔は時間単位でしか許可されませんので、デバッグ以外では @ref Initialize を利用してください。]ポリシーの設定を行います。実行間隔は秒単位で指定します。

      （1秒～168時間が利用できる有効な範囲です。）

  @param[in]    priority    タスク実行の優先度を指定します。
  @param[in]    intervalSec タスクの実行間隔を指定します。単位は秒です。
  @param[in]    count       タスクの実行回数を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       初期化に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    nn::Result InitializeWithSecInterval(TaskPriority priority, u32 intervalSec, u32 count);

/*!
  @brief        １回の実行時間の目安を設定します。（将来的にサポート予定です）
  @param[in]    duration        １回の実行時間の目安を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       設定に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    nn::Result SetDuration(u32 duration);

/*!
  @brief        タスク実行の優先度を設定します。
                優先度の種類については、@ref TaskPriorityを参照ください。
                通常、アプリケーションは、デフォルト値（@ref PRIORITY_MEDIUM）を使用しますので、変更する必要はありません。
                特定のAPで動作させたいタスクの場合は、@ref PRIORITY_STOPPED に変更が必要になります。
                タスク実行の優先度は、状況およびサーバからの設定に従いスケジューラによって適切に変更されます。
  @param[in]    priority    タスク実行の優先度を指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess       設定に成功しました。
  @retval       上記以外            想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    nn::Result SetPriority(TaskPriority priority);


/*!
  @brief        クラス内のプロパティの値を設定します。説明部のデータ型の領域を確保した後、呼び出してください。
                下記のプロパティを使用できます。\n
        識別子                     説明 \n
        TASK_PERMISSION            タスク実行に伴うペアレンタルコントロール・EULAパーミッションの制御設定。データの型は、TaskPermission です。 \n
  @param[in]    type    プロパティの識別子を指定します。
  @param[in]    pValue  値を指定します。
  @param[in]    size    値のサイズを指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess               設定に成功しました。
  @retval       ResultInvalidPropertyValue  プロパティ値のポインタがNULLです。
  @retval       ResultInvalidPropertyType   プロパティタイプがサポート外です。
  @retval       上記以外                    想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    nn::Result SetProperty(PropertyType type, void* pValue, size_t size);

/*!
  @brief        クラス内のプロパティの値を取得します。説明部のデータ型の領域を確保した後、呼び出してください。
                下記のプロパティを使用できます。\n
        識別子                     説明 \n
        TASK_PRIORITY              タスク登録時のタスク実行優先順位。データの型は、TaskPriorityです。     \n
        TASK_SCHEDULING_POLICY     タスクのスケジューリングポリシー。データの型は、SchedulingPolicyです。 \n
        TASK_EXEC_INTERVAL         タスクの実行間隔。データの型は、u32（秒）です。 \n
        TASK_EXEC_COUNT            タスクの消尽回数。データの型は、u16です。       \n
        TASK_PERMISSION            タスク実行に伴うペアレンタルコントロール・EULAパーミッションの制御設定。データの型は、TaskPermission です。 \n
  @param[in]    type    プロパティの識別子を指定します。
  @param[out]   pValue  値を指定します。
  @param[in]    size    値のサイズを指定します。
  @return       関数の実行結果を返します。以下に挙げる Result を返します。
  @retval       ResultSuccess               取得に成功しました。
  @retval       ResultInvalidPropertyValue  プロパティ値のポインタがNULLです。
  @retval       ResultInvalidPropertyType   プロパティタイプがサポート外です。
  @retval       上記以外                    想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。
*/
    nn::Result GetProperty(PropertyType type, void* pValue, size_t size);

protected:
    friend class AccessConfig;
    TaskPolicyConfig    m_Policy;
  private:
};

}
}

#endif

#endif /* NN_BOSS_BOSS_TASK_POLICY_H_ */