X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=service%2Fresource-encapsulation%2Finclude%2FRCSResponse.h;h=6a1a36bfc3c75397af88c27b97b0f079a2716d7f;hb=17c68b2fd1e74586f85e552eeab4e32dc121f8a0;hp=afe6c10cf78f510ebdd4f081122eb306df1f5ef8;hpb=8c01dff2c5bc5496f7dc1632c498943ec6ecb015;p=platform%2Fupstream%2Fiotivity.git diff --git a/service/resource-encapsulation/include/RCSResponse.h b/service/resource-encapsulation/include/RCSResponse.h index afe6c10..6a1a36b 100644 --- a/service/resource-encapsulation/include/RCSResponse.h +++ b/service/resource-encapsulation/include/RCSResponse.h @@ -18,19 +18,17 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + /** * @file * - * This file contains the classes for creating Get & Set response for the Get & Set request. + * This file contains the declaration of classes and its members related to RCSResponse */ #ifndef SERVERBUILDER_RCSRESPONSE_H #define SERVERBUILDER_RCSRESPONSE_H -#include #include -#include - namespace OIC { namespace Service @@ -42,7 +40,7 @@ namespace OIC /** * This class provides factory methods to create the response for a received get request. - * The response consists of a result code, an error code and result attributes. + * The response consists of an error code and result attributes. * * @see RCSResourceObject */ @@ -51,21 +49,20 @@ namespace OIC public: /** * Creates a default RCSGetResponse. - * The response will have OC_EH_OK for the result and 200 for the errorCode. - * The attributes of RCSResourceObject will be set as the result attributes. + * The response will have 200 for the errorCode and the attributes of RCSResourceObject + * will be set as the result attributes. * */ static RCSGetResponse defaultAction(); /** - * Creates a RCSGetResponse with a result and error code passed. + * Creates a RCSGetResponse with error code passed. * The attributes of the RCSResourceObject will be set as the result attributes. * - * @param result The response result. * @param errorCode The error code to set in response. * */ - static RCSGetResponse create(const OCEntityHandlerResult& result, int errorCode); + static RCSGetResponse create(int errorCode); /** * Creates a RCSGetResponse with custom attributes. @@ -85,25 +82,22 @@ namespace OIC static RCSGetResponse create(RCSResourceAttributes&& attrs); /** - * Creates a RCSGetResponse with a result and error code passed. + * Creates a RCSGetResponse with error code passed. * This sends the passed attributes as the result attributes * instead of the one the RCSResourceObject holds. * * @param attrs The attributes to set. - * @param result The response result. * @param errorCode The error code for response. * * @see RCSResourceAttributes * */ - static RCSGetResponse create(const RCSResourceAttributes& attrs, - const OCEntityHandlerResult& result, int errorCode); + static RCSGetResponse create(const RCSResourceAttributes& attrs, int errorCode); /** * @override */ - static RCSGetResponse create(RCSResourceAttributes&& attrs, - const OCEntityHandlerResult& result, int errorCode); + static RCSGetResponse create(RCSResourceAttributes&& attrs, int errorCode); //! @cond RequestHandler* getHandler() const; @@ -118,9 +112,9 @@ namespace OIC /** * This class provides factory methods to create the response for a received set request. - * The response consists of a result code, an error code and result attributes. + * The response consists of an error code and result attributes. * - * AcceptanceMethod provides ways how to handle attributes from a request. + * AcceptanceMethod provides ways how the request will be handled. * * @see RCSResourceObject */ @@ -155,7 +149,7 @@ namespace OIC /** * Creates a default RCSSetResponse that has AcceptanceMethod::DEFAULT. - * The response will have OC_EH_OK for the result and 200 for the errorCode. + * The response will have 200 for the errorCode. * The attributes of RCSResourceObject will be set as the result attributes. * */ @@ -163,52 +157,46 @@ namespace OIC /** * Creates a default RCSSetResponse that has AcceptanceMethod::ACCEPT. - * The response will have OC_EH_OK for the result and 200 for the errorCode. + * The response will have 200 for the errorCode. * The attributes of RCSResourceObject will be set as the result attributes. * */ static RCSSetResponse accept(); /** - * Creates a RCSSetResponse that has AcceptanceMethod::ACCEPT - * with a result and error code passed. + * Creates a RCSSetResponse that has AcceptanceMethod::ACCEPT and error code passed. * The attributes of the RCSResourceObject will be set as the result attributes. * - * @param result The response result. * @param errorCode The error code to set in response. * */ - static RCSSetResponse accept(const OCEntityHandlerResult& result, int errorCode); + static RCSSetResponse accept(int errorCode); /** * Creates a default RCSSetResponse that has AcceptanceMethod::IGNORE. - * The response will have OC_EH_OK for the result and 200 for the errorCode. + * The response will have 200 for the errorCode. * The attributes of RCSResourceObject will be set as the result attributes. * */ static RCSSetResponse ignore(); /** - * Creates a RCSSetResponse that has AcceptanceMethod::IGNORE - * with a result and error code passed. + * Creates a RCSSetResponse that has AcceptanceMethod::IGNORE and error code passed. * The attributes of the RCSResourceObject will be set as the result attributes. * - * @param result The response result. * @param errorCode The error code to set in response. * */ - static RCSSetResponse ignore(const OCEntityHandlerResult& result, int errorCode); + static RCSSetResponse ignore(int errorCode); /** - * Creates a RCSSetResponse that has AcceptanceMethod::DEFAULT - * with a result and error code passed. + * Creates a RCSSetResponse that has AcceptanceMethod::DEFAULT and error code passed. * The attributes of the RCSResourceObject will be set as the result attributes. * - * @param result The response result. * @param errorCode The error code to set in response. * */ - static RCSSetResponse create(const OCEntityHandlerResult& result, int errorCode); + static RCSSetResponse create(int errorCode); /** * Creates a RCSSetResponse that has AcceptanceMethod::DEFAULT with custom attributes. @@ -225,32 +213,28 @@ namespace OIC /** * @override */ - static RCSSetResponse create(RCSResourceAttributes &&attrs); + static RCSSetResponse create(RCSResourceAttributes&& attrs); /** - * Creates a RCSSetResponse with a result and error code passed. + * Creates a RCSSetResponse with error code passed. * This sends the passed attributes as the result attributes * instead of the one the RCSResourceObject holds. * * @param attrs The attributes to set. - * @param result The response result. * @param errorCode The error code for response. * * @see RCSResourceAttributes * */ - static RCSSetResponse create(const RCSResourceAttributes& attrs, - const OCEntityHandlerResult& result, int errorCode); - + static RCSSetResponse create(const RCSResourceAttributes& attrs, int errorCode); /** * @override */ - static RCSSetResponse create(RCSResourceAttributes &&attrs, - const OCEntityHandlerResult &result, int errorCode); + static RCSSetResponse create(RCSResourceAttributes&& attrs, int errorCode); - //! @cond/ + //! @cond SetRequestHandler* getHandler() const; //! @endcond @@ -263,7 +247,7 @@ namespace OIC /** * Sets the acceptance method for the RCSSetResponse. * - * @param method - AcceptanceMethod value to set + * @param method AcceptanceMethod value to set * * @return The reference to this RCSSetResponse *