/*---------------------------------------------------------------------------*

  Copyright (C) 2012 Nintendo. 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.

 *---------------------------------------------------------------------------*/

#ifndef NN_NGC_CAFE_NGC_RESULT_H_
#define NN_NGC_CAFE_NGC_RESULT_H_

#include <nn/Result.h>
#include <nn/Modules.h>


/*! @file
    @brief      Profanity Filter (NGC) library <tt>Result</tt> classes.
*/


namespace nn {
namespace ngc {
namespace Cafe {

/*!
    @ingroup    nn_ngc
    @defgroup   nn_ngc_result  Profanity Filter (NGC) Results
    @brief      <tt>Result</tt> classes used in the Profanity Filter (NGC) library.
    @{
*/



    /*! @private
    @brief <tt>Result</tt> code details.
    */
    enum Description
    {
        DESCRIPTION_NOT_INITIALIZED          = 1,       //!< Not initialized.
        DESCRIPTION_ALREADY_INITIALIZED      = 2,       //!< Already initialized.
        DESCRIPTION_INVALID_POINTER          = 3,       //!< Invalid pointer.
        DESCRIPTION_INVALID_SIZE             = 4,       //!< The size is invalid.
        DESCRIPTION_MOUNT_CONTENTS_FAILED    = 5,       //!< Failed to mount content.
        DESCRIPTION_OPEN_CONTENTS_FAILED     = 6,       //!< Failed to open content.
        DESCRIPTION_READ_CONTENTS_FAILED     = 7,       //!< Failed to read content.
        DESCRIPTION_MAX
    };

/*!
    @class nn::ngc::Cafe::ResultNotInitialized
@brief Indicates that the library is not initialized.
*/
    NN_DEFINE_RESULT_CONST(
        ResultNotInitialized,
        nn::Result::LEVEL_USAGE, nn::Result::SUMMARY_INVALID_STATE, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_NOT_INITIALIZED
    );

/*! @private
    @class nn::ngc::Cafe::ResultAlreadyInitialized
@brief Indicates that the library is already initialized.
*/
    NN_DEFINE_RESULT_CONST(
        ResultAlreadyInitialized,
        nn::Result::LEVEL_USAGE, nn::Result::SUMMARY_INVALID_STATE, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_ALREADY_INITIALIZED
    );

/*!
    @class nn::ngc::Cafe::ResultInvalidPointer
@brief Indicates that the specified pointer is invalid.
*/
    NN_DEFINE_RESULT_CONST(
        ResultInvalidPointer,
        nn::Result::LEVEL_USAGE, nn::Result::SUMMARY_INVALID_ARGUMENT, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_INVALID_POINTER
    );

/*!
    @class nn::ngc::Cafe::ResultInvalidSize
    @brief Indicates that the specified size is invalid.
*/
    NN_DEFINE_RESULT_CONST(
        ResultInvalidSize,
        nn::Result::LEVEL_USAGE, nn::Result::SUMMARY_INVALID_ARGUMENT, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_INVALID_SIZE
    );

/*!
    @class nn::ngc::Cafe::ResultMountContentsFailed
@brief Indicates that content mounting failed.
*/
    NN_DEFINE_RESULT_CONST(
        ResultMountContentsFailed,
        nn::Result::LEVEL_FATAL, nn::Result::SUMMARY_CANCELLED, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_MOUNT_CONTENTS_FAILED
    );

/*! @private
    @class nn::ngc::Cafe::ResultOpenContentsFailed
@brief Indicates that opening the content failed.
*/
    NN_DEFINE_RESULT_CONST(
        ResultOpenContentsFailed,
        nn::Result::LEVEL_FATAL, nn::Result::SUMMARY_CANCELLED, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_OPEN_CONTENTS_FAILED
    );

/*!
    @class nn::ngc::Cafe::ResultReadContentsFailed
@brief Indicates that loading the content failed.
*/
    NN_DEFINE_RESULT_CONST(
        ResultReadContentsFailed,
        nn::Result::LEVEL_FATAL, nn::Result::SUMMARY_CANCELLED, nn::RESULT_MODULE_NN_NGC, DESCRIPTION_READ_CONTENTS_FAILED
    );


/*!
  @}
*/

} // namespace Cafe
} // namespace ngc
} // namespace nn

#endif //NN_NGC_CAFE_NGC_RESULT_H_