com.samsung.android.penup
Class ResponseResult
- java.lang.Object
-
- com.samsung.android.penup.ResponseResult
-
public final class ResponseResult extends java.lang.ObjectThis class represents the result of the response received from the PEN.UP service.- Since:
- PEN.UP 1.0
-
-
Field Summary
Fields Modifier and Type Field and Description static intCODE_ACCESS_TOKEN_EXPIREDThe result code for when the access token is expiredstatic intCODE_AUTHENTICATION_CANCELEDThe result code for when the authentication is canceled by userstatic intCODE_AUTHENTICATION_ERRORThe result code for when the authentication error occurredstatic intCODE_AUTHENTICATION_REQUIREDThe result code for when the authentication is requiredstatic intCODE_INTERNAL_SERVER_ERRORThe result code for when the internal server error occurredstatic intCODE_INVALID_ACCESS_TOKENThe result code for when the access token is invalidstatic intCODE_INVALID_CLIENT_IDThe result code for when the client ID is invalidstatic intCODE_KEY_HASH_MISMATCHEDThe result code for when the key hash is mismatchedstatic intCODE_NETWORK_ERRORThe result code for when the network connection error occurredstatic intCODE_NOT_EXIST_ARTISTThe result code for when the artist does not existstatic intCODE_NOT_EXIST_ARTWORKThe result code for when the artwork does not existstatic intCODE_NOT_EXIST_COLLECTIONThe result code for when the collection does not existstatic intCODE_NOT_EXIST_TAGThe result code for when the tag does not existstatic intCODE_PERMISSION_DENIEDThe result code for when the permission is deniedstatic intCODE_POST_DIALOG_CANCELEDThe result code for when the post dialog is canceled by userstatic intCODE_SUCCESSThe result code for the successstatic intCODE_TIMEOUTThe result code for when the timeout is exceeded
-
Constructor Summary
Constructors Constructor and Description ResponseResult(int code, java.lang.String message)Constructs an instance of ResponseResult with the specified parameters.
-
Method Summary
Methods Modifier and Type Method and Description intgetCode()Gets the result code.java.lang.StringgetMessage()Gets the result message.booleanisSuccess()Checks whether the request is successfully processed and the corresponding response is received.
-
-
-
Field Detail
-
CODE_SUCCESS
public static final int CODE_SUCCESS
The result code for the success- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_INTERNAL_SERVER_ERROR
public static final int CODE_INTERNAL_SERVER_ERROR
The result code for when the internal server error occurred- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_AUTHENTICATION_REQUIRED
public static final int CODE_AUTHENTICATION_REQUIRED
The result code for when the authentication is required- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_AUTHENTICATION_ERROR
public static final int CODE_AUTHENTICATION_ERROR
The result code for when the authentication error occurred- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_AUTHENTICATION_CANCELED
public static final int CODE_AUTHENTICATION_CANCELED
The result code for when the authentication is canceled by user- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_INVALID_CLIENT_ID
public static final int CODE_INVALID_CLIENT_ID
The result code for when the client ID is invalid- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_PERMISSION_DENIED
public static final int CODE_PERMISSION_DENIED
The result code for when the permission is denied- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_ACCESS_TOKEN_EXPIRED
public static final int CODE_ACCESS_TOKEN_EXPIRED
The result code for when the access token is expired- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_INVALID_ACCESS_TOKEN
public static final int CODE_INVALID_ACCESS_TOKEN
The result code for when the access token is invalid- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_KEY_HASH_MISMATCHED
public static final int CODE_KEY_HASH_MISMATCHED
The result code for when the key hash is mismatched- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_NOT_EXIST_ARTIST
public static final int CODE_NOT_EXIST_ARTIST
The result code for when the artist does not exist- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_NOT_EXIST_ARTWORK
public static final int CODE_NOT_EXIST_ARTWORK
The result code for when the artwork does not exist- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_NOT_EXIST_COLLECTION
public static final int CODE_NOT_EXIST_COLLECTION
The result code for when the collection does not exist- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_NOT_EXIST_TAG
public static final int CODE_NOT_EXIST_TAG
The result code for when the tag does not exist- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_POST_DIALOG_CANCELED
public static final int CODE_POST_DIALOG_CANCELED
The result code for when the post dialog is canceled by user- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_NETWORK_ERROR
public static final int CODE_NETWORK_ERROR
The result code for when the network connection error occurred- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
CODE_TIMEOUT
public static final int CODE_TIMEOUT
The result code for when the timeout is exceeded- See Also:
- Constant Field Values
- Since:
- PEN.UP 1.0
-
-
Constructor Detail
-
ResponseResult
public ResponseResult(int code, java.lang.String message)Constructs an instance of ResponseResult with the specified parameters.- Parameters:
code- The result code which is one of the followings:
CODE_SUCCESSCODE_INTERNAL_SERVER_ERRORCODE_AUTHENTICATION_REQUIREDCODE_AUTHENTICATION_ERRORCODE_AUTHENTICATION_CANCELEDCODE_INVALID_CLIENT_IDCODE_PERMISSION_DENIEDCODE_ACCESS_TOKEN_EXPIREDCODE_INVALID_ACCESS_TOKENCODE_KEY_HASH_MISMATCHEDCODE_NOT_EXIST_ARTISTCODE_NOT_EXIST_ARTWORKCODE_NOT_EXIST_COLLECTIONCODE_NOT_EXIST_TAGCODE_POST_DIALOG_CANCELEDCODE_NETWORK_ERRORCODE_TIMEOUT
message- The result message to describe the code- Since:
- PEN.UP 1.0
-
-
Method Detail
-
getCode
public int getCode()
Gets the result code.- Returns:
- The result code which is one of the followings:
CODE_SUCCESSCODE_INTERNAL_SERVER_ERRORCODE_AUTHENTICATION_REQUIREDCODE_AUTHENTICATION_ERRORCODE_AUTHENTICATION_CANCELEDCODE_INVALID_CLIENT_IDCODE_PERMISSION_DENIEDCODE_ACCESS_TOKEN_EXPIREDCODE_INVALID_ACCESS_TOKENCODE_KEY_HASH_MISMATCHEDCODE_NOT_EXIST_ARTISTCODE_NOT_EXIST_ARTWORKCODE_NOT_EXIST_COLLECTIONCODE_NOT_EXIST_TAGCODE_POST_DIALOG_CANCELEDCODE_NETWORK_ERRORCODE_TIMEOUT
- Since:
- PEN.UP 1.0
-
getMessage
public java.lang.String getMessage()
Gets the result message.- Returns:
- The result message
- See Also:
getCode()- Since:
- PEN.UP 1.0
-
isSuccess
public boolean isSuccess()
Checks whether the request is successfully processed and the corresponding response is received.- Returns:
trueif the request is successfully processed and the corresponding response is received,
falseotherwise- Since:
- PEN.UP 1.0
-
-