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

  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 __FP_RESULT_H__
#define __FP_RESULT_H__

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

namespace nn { namespace fp {

//! @addtogroup    nn_fp_result
//! @{


/*!
    @class    nn::fp::ResultProgrammingError
    @brief     Programming error.

    Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects.

    @li <tt>@ref nn::fp::ResultNotInitialized</tt>
    @li <tt>@ref nn::fp::ResultAlreadyInitialized</tt>
    @li <tt>@ref nn::fp::ResultInvalidArgument</tt>
    @li <tt>@ref nn::fp::ResultBusy</tt>
    @li <tt>@ref nn::fp::ResultNetworkClockInvalid</tt>
    @li <tt>@ref nn::fp::ResultNotPermitted</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultProgrammingError, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1280, 1280, 12800
);

/*!
    @class    nn::fp::ResultNotInitialized
    @brief     The library has not been initialized.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultNotInitialized, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1408, 1408, 1536
);

/*!
    @class    nn::fp::ResultAlreadyInitialized
    @brief     The library is already initialized.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultAlreadyInitialized, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1536, 1536, 1664
);

/*!
    @class    nn::fp::ResultInvalidArgument
    @brief     Invalid parameter.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultInvalidArgument, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1664, 1664, 1792
);

/*!
    @class    nn::fp::ResultBusy
    @brief     Too many calls to the asynchronous process.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultBusy, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1792, 1792, 1920
);

/*!
    @class    nn::fp::ResultNetworkClockInvalid
    @brief     The network time is not yet valid.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultNetworkClockInvalid, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 1920, 1920, 2048
);

/*!
    @class    nn::fp::ResultNotPermitted
    @brief     Use of this function is not permitted.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultProgrammingError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultNotPermitted, 
    nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_FP, 2048, 2048, 2176
);

/*!
    @class    nn::fp::ResultSystemError
    @brief     System error. Display the network error code.

    Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects.

    @li <tt>@ref nn::fp::ResultCoreOperationAborted</tt>
    @li <tt>@ref nn::fp::ResultCoreTimeout</tt>
    @li <tt>@ref nn::fp::ResultCoreInitializationFailure</tt>
    @li <tt>@ref nn::fp::ResultTransportConnectionFailure</tt>
    @li <tt>@ref nn::fp::ResultFpdNotConnected</tt>
    @li <tt>@ref nn::fp::ResultFpdAddFriendProhibited</tt>
    @li <tt>@ref nn::fp::ResultFpdInvalidAccount</tt>
    @li <tt>@ref nn::fp::ResultFpdBlacklistedByMe</tt>
    @li <tt>@ref nn::fp::ResultFpdFriendAlreadyAdded</tt>
    @li <tt>@ref nn::fp::ResultFpdMyFriendListLimitExceed</tt>
    @li <tt>@ref nn::fp::ResultFpdRequestLimitExceed</tt>
    @li <tt>@ref nn::fp::ResultFpdFriendRequestBlocked</tt>
    @li <tt>@ref nn::fp::ResultFpdNotInMyFriendList</tt>
    @li <tt>@ref nn::fp::ResultFpdFriendListedByMe</tt>
    @li <tt>@ref nn::fp::ResultFpdNotInMyBlacklist</tt>
    @li <tt>@ref nn::fp::ResultFpdNotNetworkAccount</tt>
    @li <tt>@ref nn::fp::ResultFpdPreferenceNotInitialized</tt>
    @li <tt>@ref nn::fp::ResultFpdFriendRequestNotAllowed</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultSystemError, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 12800, 12800, 128000
);

/*!
    @class    nn::fp::ResultCoreOperationAborted
    @brief     Indicates that the process was aborted. Issued when the network is disconnected during an asynchronous process.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultCoreOperationAborted, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 13440, 13440, 13568
);

/*!
    @class    nn::fp::ResultCoreTimeout
    @brief     Indicates that an asynchronous process has timed out.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultCoreTimeout, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 14336, 14336, 14464
);

/*!
    @class    nn::fp::ResultCoreInitializationFailure
    @brief     Indicates that starting an asynchronous process failed.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultCoreInitializationFailure, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 14464, 14464, 14592
);

/*!
    @class    nn::fp::ResultTransportConnectionFailure
    @brief     Indicates that there was no response from the friend server. This result also occurs when not connected to the network or when the asynchronous process was forcibly terminated.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultTransportConnectionFailure, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 64256, 64256, 64384
);

/*!
    @class    nn::fp::ResultFpdNotConnected
    @brief     Indicates that the local user is not logged in to the friend server.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdNotConnected, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 90112, 90112, 90240
);

/*!
    @class    nn::fp::ResultFpdAddFriendProhibited
    @brief     Indicates that the addition of friends is prohibited by Parental Controls.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdAddFriendProhibited, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 92800, 92800, 92928
);

/*!
    @class    nn::fp::ResultFpdInvalidAccount
    @brief     Indicates that a non-existent user or oneself has been specified.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdInvalidAccount, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 93056, 93056, 93184
);

/*!
    @class    nn::fp::ResultFpdBlacklistedByMe
    @brief     Indicates that the specified user has been added to the blacklist.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdBlacklistedByMe, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 93184, 93184, 93312
);

/*!
    @class    nn::fp::ResultFpdFriendAlreadyAdded
    @brief     Indicates that the specified user has already been added to the friend list.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdFriendAlreadyAdded, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 93440, 93440, 93568
);

/*!
    @class    nn::fp::ResultFpdMyFriendListLimitExceed
    @brief     Indicates that the friend could not be added because the limit on the number of people who can be registered in the friend list has been reached.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdMyFriendListLimitExceed, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 93568, 93568, 93696
);

/*!
    @class    nn::fp::ResultFpdRequestLimitExceed
    @brief     Indicates that the request could not be sent because the recipient's request list has reached its limit for the number of requests it can receive.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdRequestLimitExceed, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 93696, 93696, 93824
);

/*!
    @class    nn::fp::ResultFpdFriendRequestBlocked
    @brief     Indicates that the friend request has been blocked.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdFriendRequestBlocked, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 94208, 94208, 94336
);

/*!
    @class    nn::fp::ResultFpdNotInMyFriendList
    @brief     Indicates that a user who does not exist in the friend list has been specified.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdNotInMyFriendList, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 94336, 94336, 94464
);

/*!
    @class    nn::fp::ResultFpdFriendListedByMe
    @brief     Indicates an attempt to add a friend to the blacklist.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdFriendListedByMe, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 94464, 94464, 94592
);

/*!
    @class    nn::fp::ResultFpdNotInMyBlacklist
    @brief     Indicates that the specified user is not on the blacklist.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdNotInMyBlacklist, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 94592, 94592, 94720
);

/*!
    @class    nn::fp::ResultFpdNotNetworkAccount
    @brief     Indicates that the network account is not loaded.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdNotNetworkAccount, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 95232, 95232, 95360
);

/*!
    @class    nn::fp::ResultFpdPreferenceNotInitialized
    @brief     Indicates that the friend list settings have not been performed even once.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdPreferenceNotInitialized, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 95488, 95488, 95616
);

/*!
    @class    nn::fp::ResultFpdFriendRequestNotAllowed
    @brief     Indicates that the sending of friend requests is not allowed.

    This result is subsumed by the following results and can be caught by handling any of them. 

    @li <tt>@ref nn::fp::ResultSystemError</tt>


*/
NN_DEFINE_RESULT_CONST_RANGE(
    ResultFpdFriendRequestNotAllowed, 
    nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_FP, 95616, 95616, 95744
);

//! @}

}}

#endif // __FP_RESULT_H__