ReturnCode (CWS - API 1.1.0 API)

java.lang.Object
- java.lang.Enum<ReturnCode>
- - io.javadog.cws.api.common.ReturnCode

All Implemented Interfaces:

Serializable, Comparable<ReturnCode>
```
public enum ReturnCode
extends Enum<ReturnCode>
```
Common Return Codes, used for all requests, to help specify the nature of the problem which may have occurred, if processing wasn't successful.

Since:

CWS 1.0

Author:

Kim Jensen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ReturnCode.Classification
ReturnCode Classification, i.e.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReturnCode.Classification` ReturnCode Classification, i.e.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHENTICATION_WARNING` HTTP Status Code 403 - Forbidden. The request was valid, but the server is refusing action.
`AUTHORIZATION_WARNING` HTTP Status Code 401 - Unauthorized (RFC 7235). Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.
`CONSTRAINT_ERROR` Custom Warning 596 - Constraint Error. A unique constraint violation occurred in the database.
`CRYPTO_ERROR` Custom Warning 591 - General Cryptographic Error. A generic cryptographic error occurred during the request.
`DATABASE_ERROR` Custom Warning 595 - Database Error. A generic problem with the database occurred.
`ERROR` HTTP Status Code 500 - Internal Server Error. A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
`IDENTIFICATION_WARNING` HTTP Status Code 404 - Not Found. The requested resource could not be found but may be available in the future.
`ILLEGAL_ACTION` HTTP Status Code 405 - Method Not Allowed. A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
`INTEGRITY_ERROR` Custom Warning 592 - Integrity Error. The encrypted data is having integrity errors.
`INTEGRITY_WARNING` HTTP Status Code 409 - Conflict. Indicates that the request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates.
`NETWORK_ERROR` HTTP Status Code 502 - Bad Gateway Error. It was not possible to communicate with the requested URL.
`SETTING_ERROR` Custom Warning 593 - Setting Error. Error extracting the setting value.
`SETTING_WARNING` Custom Warning 492 - Setting Warning. It is not permitted to add, alter or delete the given setting.
`SIGNATURE_WARNING` Custom Warning 491 - Cryptographic Signature Problem. The Signature is not usable, as it has expired.
`SUCCESS` HTTP Status Code 200 - OK. Standard response for successful HTTP requests.
`VERIFICATION_WARNING` HTTP Status Code 406 - Not Acceptable. The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.
`WARNING` HTTP Status Code 400 - Bad Request. The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReturnCode`	`findReturnCode(int code)` Converts the actual code (integer value) to a ReturnCode enum value.
`ReturnCode.Classification`	`getClassification()`
`int`	`getCode()`
`String`	`getDescription()`
`int`	`getHttpCode()`
`static ReturnCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ReturnCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SUCCESS
```
public static final ReturnCode SUCCESS
```
    HTTP Status Code 200 - OK.
    Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
  - WARNING
```
public static final ReturnCode WARNING
```
    HTTP Status Code 400 - Bad Request.
    The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).
  - AUTHORIZATION_WARNING
```
public static final ReturnCode AUTHORIZATION_WARNING
```
    HTTP Status Code 401 - Unauthorized (RFC 7235).
    Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. See Basic access authentication and Digest access authentication. 401 semantically means "unauthenticated", i.e. the user does not have the necessary credentials.
    Note: Some sites issue HTTP 401 when an IP address is banned from the website (usually the website domain) and that specific address is refused permission to access a website.
  - AUTHENTICATION_WARNING
```
public static final ReturnCode AUTHENTICATION_WARNING
```
    HTTP Status Code 403 - Forbidden.
    The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.
  - IDENTIFICATION_WARNING
```
public static final ReturnCode IDENTIFICATION_WARNING
```
    HTTP Status Code 404 - Not Found.
    The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.
  - ILLEGAL_ACTION
```
public static final ReturnCode ILLEGAL_ACTION
```
    HTTP Status Code 405 - Method Not Allowed.
    A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
  - VERIFICATION_WARNING
```
public static final ReturnCode VERIFICATION_WARNING
```
    HTTP Status Code 406 - Not Acceptable.
    The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.
  - INTEGRITY_WARNING
```
public static final ReturnCode INTEGRITY_WARNING
```
    HTTP Status Code 409 - Conflict.
    Indicates that the request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates.
  - SIGNATURE_WARNING
```
public static final ReturnCode SIGNATURE_WARNING
```
    Custom Warning 491 - Cryptographic Signature Problem.
    The Signature is not usable, as it has expired.
  - SETTING_WARNING
```
public static final ReturnCode SETTING_WARNING
```
    Custom Warning 492 - Setting Warning.
    It is not permitted to add, alter or delete the given setting.
  - ERROR
```
public static final ReturnCode ERROR
```
    HTTP Status Code 500 - Internal Server Error.
    A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
  - NETWORK_ERROR
```
public static final ReturnCode NETWORK_ERROR
```
    HTTP Status Code 502 - Bad Gateway Error.
    It was not possible to communicate with the requested URL.
  - CRYPTO_ERROR
```
public static final ReturnCode CRYPTO_ERROR
```
    Custom Warning 591 - General Cryptographic Error.
    A generic cryptographic error occurred during the request.
  - INTEGRITY_ERROR
```
public static final ReturnCode INTEGRITY_ERROR
```
    Custom Warning 592 - Integrity Error.
    The encrypted data is having integrity errors.
  - SETTING_ERROR
```
public static final ReturnCode SETTING_ERROR
```
    Custom Warning 593 - Setting Error.
    Error extracting the setting value.
  - DATABASE_ERROR
```
public static final ReturnCode DATABASE_ERROR
```
    Custom Warning 595 - Database Error.
    A generic problem with the database occurred.
  - CONSTRAINT_ERROR
```
public static final ReturnCode CONSTRAINT_ERROR
```
    Custom Warning 596 - Constraint Error.
    A unique constraint violation occurred in the database.
- Method Detail
  - values
```
public static ReturnCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ReturnCode c : ReturnCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ReturnCode valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getClassification
```
public ReturnCode.Classification getClassification()
```
  - getCode
```
public int getCode()
```
  - getHttpCode
```
public int getHttpCode()
```
  - getDescription
```
public String getDescription()
```
  - findReturnCode
```
public static ReturnCode findReturnCode(int code)
```
    Converts the actual code (integer value) to a ReturnCode enum value. If the value cannot be found, the ReturnCode ERROR is then returned.
    
    Parameters:
    
    code - The integer value to convert to a ReturnCode enum value
    
    Returns:
    
    ReturnCode enum value

Enum ReturnCode

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SUCCESS

WARNING

AUTHORIZATION_WARNING

AUTHENTICATION_WARNING

IDENTIFICATION_WARNING

ILLEGAL_ACTION

VERIFICATION_WARNING

INTEGRITY_WARNING

SIGNATURE_WARNING

SETTING_WARNING

ERROR

NETWORK_ERROR

CRYPTO_ERROR

INTEGRITY_ERROR

SETTING_ERROR

DATABASE_ERROR

CONSTRAINT_ERROR

Method Detail

values

valueOf

getClassification

getCode

getHttpCode

getDescription

findReturnCode