MessageCode (ALL-OpenEstate-IS24-REST 0.2 API)

java.lang.Object
- java.lang.Enum<MessageCode>
- - org.openestate.is24.restapi.xml.common.MessageCode

All Implemented Interfaces:: Serializable, Comparable<MessageCode>

public enum MessageCode
extends Enum<MessageCode>

Java class for MessageCode.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="MessageCode">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="MESSAGE_RESOURCE_CREATED"/>
     <enumeration value="MESSAGE_RESOURCE_UPDATED"/>
     <enumeration value="MESSAGE_RESOURCE_DELETED"/>
     <enumeration value="MESSAGE_OPERATION_SUCCESSFUL"/>
     <enumeration value="ERROR_COMMON_HEADER_PARAMETER_VALIDATION_FAILED"/>
     <enumeration value="ERROR_COMMON_RESOURCE_REQUIRED"/>
     <enumeration value="ERROR_COMMON_REQUEST_CONFLICT"/>
     <enumeration value="ERROR_COMMON_AUTHENTICATION_REQUIRED"/>
     <enumeration value="ERROR_COMMON_AUTHENTICATION_OAUTH_NONCE_EXPIRED"/>
     <enumeration value="ERROR_COMMON_ACCESS_DENIED"/>
     <enumeration value="ERROR_COMMON_SCHEMA_VALIDATION_FAILED"/>
     <enumeration value="ERROR_COMMON_URL_PARAMETER_REQUIRED"/>
     <enumeration value="ERROR_COMMON_URL_PARAMETER_VALIDATION_FAILED"/>
     <enumeration value="ERROR_COMMON_URL_MULTIPLE_PARAMETERS_NOT_ALLOWED"/>
     <enumeration value="ERROR_COMMON_URL_PARAMETER_NOT_SUPPORTED"/>
     <enumeration value="ERROR_COMMON_NOT_IMPLEMENTED"/>
     <enumeration value="ERROR_COMMON_SERVICE_UNAVAILABLE"/>
     <enumeration value="ERROR_COMMON_INTERNAL_SERVER_ERROR"/>
     <enumeration value="ERROR_COMMON_UNPROCESSABLE_ENTITY"/>
     <enumeration value="ERROR_COMMON_INTERNAL_SERVER_ERROR_WITH_DETAILS"/>
     <enumeration value="ERROR_COMMON_RESOURCE_NOT_FOUND"/>
     <enumeration value="ERROR_COMMON_METHOD_NOT_ALLOWED"/>
     <enumeration value="ERROR_COMMON_ACCEPT_TYPE_NOT_APPLICABLE"/>
     <enumeration value="ERROR_COMMON_MEDIA_TYPE_UNSUPPORTED"/>
     <enumeration value="ERROR_COMMON_BAD_REQUEST"/>
     <enumeration value="ERROR_RESOURCE_NOT_SUPPORTED"/>
     <enumeration value="ERROR_RESOURCE_NOT_FOUND"/>
     <enumeration value="ERROR_RESOURCE_NOT_FOUND_FOR_MULTIPLE_PARAMETERS"/>
     <enumeration value="ERROR_RESOURCE_VALIDATION"/>
     <enumeration value="ERROR_REQUESTED_DATA_NOT_FOUND"/>
     <enumeration value="ERROR_RESOURCE_NOT_UNIQUE"/>
     <enumeration value="ERROR_RESOURCE_NO_LONGER_AVAILABLE"/>
     <enumeration value="ERROR_DB_NOT_AVAILABLE"/>
     <enumeration value="ERROR_CONTACT_DETAILS_MISSING"/>
     <enumeration value="ERROR_INVALID_COORDINATES"/>
     <enumeration value="ERROR_GEOCODING_FAILED"/>
   </restriction>
 </simpleType>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ERROR_COMMON_ACCEPT_TYPE_NOT_APPLICABLE` Accept type not applicable.
`ERROR_COMMON_ACCESS_DENIED` No authorization for the requested operation.
`ERROR_COMMON_AUTHENTICATION_OAUTH_NONCE_EXPIRED` The OAuth Nonce has expired.
`ERROR_COMMON_AUTHENTICATION_REQUIRED` No authorization for the requested operation.
`ERROR_COMMON_BAD_REQUEST` The http request is invalid (check the url or body content).
`ERROR_COMMON_HEADER_PARAMETER_VALIDATION_FAILED` Operation successful executed.
`ERROR_COMMON_INTERNAL_SERVER_ERROR` HTTP 500: Internal Server Error
`ERROR_COMMON_INTERNAL_SERVER_ERROR_WITH_DETAILS` HTTP 500: Internal Server Error with Details
`ERROR_COMMON_MEDIA_TYPE_UNSUPPORTED` Media type is not supported.
`ERROR_COMMON_METHOD_NOT_ALLOWED` Method not allowed for this resource.
`ERROR_COMMON_NOT_IMPLEMENTED` HTTP 501: The method is not yet implemented.
`ERROR_COMMON_REQUEST_CONFLICT` A conflict occured during execution of an operation (e.g.
`ERROR_COMMON_RESOURCE_NOT_FOUND` Resource was not found.
`ERROR_COMMON_RESOURCE_REQUIRED` Request is only valid within the context of an specific resource (includes name of the required resource).
`ERROR_COMMON_SCHEMA_VALIDATION_FAILED` Validation according the schema failed (includes the description of the failure).
`ERROR_COMMON_SERVICE_UNAVAILABLE` HTTP 503: Service Unavailable
`ERROR_COMMON_UNPROCESSABLE_ENTITY` HTTP 422: Unprocessable Entity
`ERROR_COMMON_URL_MULTIPLE_PARAMETERS_NOT_ALLOWED` Multiple parameters are not allowed.
`ERROR_COMMON_URL_PARAMETER_NOT_SUPPORTED` A request parameter is not supported (contains the name of the parameter).
`ERROR_COMMON_URL_PARAMETER_REQUIRED` A required parameter is missing in the request (contains the name of the parameter).
`ERROR_COMMON_URL_PARAMETER_VALIDATION_FAILED` At least one request parameter contains an invalid value (contains the name and the value of the parameter).
`ERROR_CONTACT_DETAILS_MISSING` Contact data is missing some attributes.
`ERROR_DB_NOT_AVAILABLE` The DB ist not reachable.
`ERROR_GEOCODING_FAILED` The geocoding was not successful.
`ERROR_INVALID_COORDINATES` The given coordinates are invalid.
`ERROR_REQUESTED_DATA_NOT_FOUND` The requested data was not found.
`ERROR_RESOURCE_NO_LONGER_AVAILABLE` resource requested is no longer available and will not be available again.
`ERROR_RESOURCE_NOT_FOUND` Resource was not found (includes name and id of the resource).
`ERROR_RESOURCE_NOT_FOUND_FOR_MULTIPLE_PARAMETERS` Resource was not found for at least one of the given parameters.
`ERROR_RESOURCE_NOT_SUPPORTED` The resource is not supported within the context of the request (includes name of the unauthorized and unavailable resource e.g.
`ERROR_RESOURCE_NOT_UNIQUE` The requested resource is not unique, but is expected to be unique.
`ERROR_RESOURCE_VALIDATION` Not all of the data for the resource are valid (includes the description of the failure).
`MESSAGE_OPERATION_SUCCESSFUL` Operation successful executed.
`MESSAGE_RESOURCE_CREATED` Resource was successful created (includes name and id of the resource).
`MESSAGE_RESOURCE_DELETED` Resource was successful deleted (includes name and id of the resource).
`MESSAGE_RESOURCE_UPDATED` Resource was successful updated (includes name and id of the resource).

Method Summary

Methods
Modifier and Type	Method and Description
`static MessageCode`	`fromValue(String v)`
`String`	`value()`
`static MessageCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MessageCode[]`	`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
  - MESSAGE_RESOURCE_CREATED
```
public static final MessageCode MESSAGE_RESOURCE_CREATED
```
    Resource was successful created (includes name and id of the resource).
  - MESSAGE_RESOURCE_UPDATED
```
public static final MessageCode MESSAGE_RESOURCE_UPDATED
```
    Resource was successful updated (includes name and id of the resource).
  - MESSAGE_RESOURCE_DELETED
```
public static final MessageCode MESSAGE_RESOURCE_DELETED
```
    Resource was successful deleted (includes name and id of the resource).
  - MESSAGE_OPERATION_SUCCESSFUL
```
public static final MessageCode MESSAGE_OPERATION_SUCCESSFUL
```
    Operation successful executed.
  - ERROR_COMMON_HEADER_PARAMETER_VALIDATION_FAILED
```
public static final MessageCode ERROR_COMMON_HEADER_PARAMETER_VALIDATION_FAILED
```
    Operation successful executed.
  - ERROR_COMMON_RESOURCE_REQUIRED
```
public static final MessageCode ERROR_COMMON_RESOURCE_REQUIRED
```
    Request is only valid within the context of an specific resource (includes name of the required resource).
  - ERROR_COMMON_REQUEST_CONFLICT
```
public static final MessageCode ERROR_COMMON_REQUEST_CONFLICT
```
    A conflict occured during execution of an operation (e.g. on a resource).
  - ERROR_COMMON_AUTHENTICATION_REQUIRED
```
public static final MessageCode ERROR_COMMON_AUTHENTICATION_REQUIRED
```
    No authorization for the requested operation.
  - ERROR_COMMON_AUTHENTICATION_OAUTH_NONCE_EXPIRED
```
public static final MessageCode ERROR_COMMON_AUTHENTICATION_OAUTH_NONCE_EXPIRED
```
    The OAuth Nonce has expired.
  - ERROR_COMMON_ACCESS_DENIED
```
public static final MessageCode ERROR_COMMON_ACCESS_DENIED
```
    No authorization for the requested operation.
  - ERROR_COMMON_SCHEMA_VALIDATION_FAILED
```
public static final MessageCode ERROR_COMMON_SCHEMA_VALIDATION_FAILED
```
    Validation according the schema failed (includes the description of the failure).
  - ERROR_COMMON_URL_PARAMETER_REQUIRED
```
public static final MessageCode ERROR_COMMON_URL_PARAMETER_REQUIRED
```
    A required parameter is missing in the request (contains the name of the parameter).
  - ERROR_COMMON_URL_PARAMETER_VALIDATION_FAILED
```
public static final MessageCode ERROR_COMMON_URL_PARAMETER_VALIDATION_FAILED
```
    At least one request parameter contains an invalid value (contains the name and the value of the parameter).
  - ERROR_COMMON_URL_MULTIPLE_PARAMETERS_NOT_ALLOWED
```
public static final MessageCode ERROR_COMMON_URL_MULTIPLE_PARAMETERS_NOT_ALLOWED
```
    Multiple parameters are not allowed.
  - ERROR_COMMON_URL_PARAMETER_NOT_SUPPORTED
```
public static final MessageCode ERROR_COMMON_URL_PARAMETER_NOT_SUPPORTED
```
    A request parameter is not supported (contains the name of the parameter).
  - ERROR_COMMON_NOT_IMPLEMENTED
```
public static final MessageCode ERROR_COMMON_NOT_IMPLEMENTED
```
    HTTP 501: The method is not yet implemented.
  - ERROR_COMMON_SERVICE_UNAVAILABLE
```
public static final MessageCode ERROR_COMMON_SERVICE_UNAVAILABLE
```
    HTTP 503: Service Unavailable
  - ERROR_COMMON_INTERNAL_SERVER_ERROR
```
public static final MessageCode ERROR_COMMON_INTERNAL_SERVER_ERROR
```
    HTTP 500: Internal Server Error
  - ERROR_COMMON_UNPROCESSABLE_ENTITY
```
public static final MessageCode ERROR_COMMON_UNPROCESSABLE_ENTITY
```
    HTTP 422: Unprocessable Entity
  - ERROR_COMMON_INTERNAL_SERVER_ERROR_WITH_DETAILS
```
public static final MessageCode ERROR_COMMON_INTERNAL_SERVER_ERROR_WITH_DETAILS
```
    HTTP 500: Internal Server Error with Details
  - ERROR_COMMON_RESOURCE_NOT_FOUND
```
public static final MessageCode ERROR_COMMON_RESOURCE_NOT_FOUND
```
    Resource was not found.
  - ERROR_COMMON_METHOD_NOT_ALLOWED
```
public static final MessageCode ERROR_COMMON_METHOD_NOT_ALLOWED
```
    Method not allowed for this resource.
  - ERROR_COMMON_ACCEPT_TYPE_NOT_APPLICABLE
```
public static final MessageCode ERROR_COMMON_ACCEPT_TYPE_NOT_APPLICABLE
```
    Accept type not applicable.
  - ERROR_COMMON_MEDIA_TYPE_UNSUPPORTED
```
public static final MessageCode ERROR_COMMON_MEDIA_TYPE_UNSUPPORTED
```
    Media type is not supported.
  - ERROR_COMMON_BAD_REQUEST
```
public static final MessageCode ERROR_COMMON_BAD_REQUEST
```
    The http request is invalid (check the url or body content).
  - ERROR_RESOURCE_NOT_SUPPORTED
```
public static final MessageCode ERROR_RESOURCE_NOT_SUPPORTED
```
    The resource is not supported within the context of the request (includes name of the unauthorized and unavailable resource e.g. savedsearch is only for searchers).
  - ERROR_RESOURCE_NOT_FOUND
```
public static final MessageCode ERROR_RESOURCE_NOT_FOUND
```
    Resource was not found (includes name and id of the resource).
  - ERROR_RESOURCE_NOT_FOUND_FOR_MULTIPLE_PARAMETERS
```
public static final MessageCode ERROR_RESOURCE_NOT_FOUND_FOR_MULTIPLE_PARAMETERS
```
    Resource was not found for at least one of the given parameters.
  - ERROR_RESOURCE_VALIDATION
```
public static final MessageCode ERROR_RESOURCE_VALIDATION
```
    Not all of the data for the resource are valid (includes the description of the failure).
  - ERROR_REQUESTED_DATA_NOT_FOUND
```
public static final MessageCode ERROR_REQUESTED_DATA_NOT_FOUND
```
    The requested data was not found.
  - ERROR_RESOURCE_NOT_UNIQUE
```
public static final MessageCode ERROR_RESOURCE_NOT_UNIQUE
```
    The requested resource is not unique, but is expected to be unique.
  - ERROR_RESOURCE_NO_LONGER_AVAILABLE
```
public static final MessageCode ERROR_RESOURCE_NO_LONGER_AVAILABLE
```
    resource requested is no longer available and will not be available again.
  - ERROR_DB_NOT_AVAILABLE
```
public static final MessageCode ERROR_DB_NOT_AVAILABLE
```
    The DB ist not reachable.
  - ERROR_CONTACT_DETAILS_MISSING
```
public static final MessageCode ERROR_CONTACT_DETAILS_MISSING
```
    Contact data is missing some attributes.
  - ERROR_INVALID_COORDINATES
```
public static final MessageCode ERROR_INVALID_COORDINATES
```
    The given coordinates are invalid.
  - ERROR_GEOCODING_FAILED
```
public static final MessageCode ERROR_GEOCODING_FAILED
```
    The geocoding was not successful.
- Method Detail
  - values
```
public static MessageCode[] 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 (MessageCode c : MessageCode.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MessageCode 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
  - value
```
public String value()
```
  - fromValue
```
public static MessageCode fromValue(String v)
```

Enum MessageCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MESSAGE_RESOURCE_CREATED

MESSAGE_RESOURCE_UPDATED

MESSAGE_RESOURCE_DELETED

MESSAGE_OPERATION_SUCCESSFUL

ERROR_COMMON_HEADER_PARAMETER_VALIDATION_FAILED

ERROR_COMMON_RESOURCE_REQUIRED

ERROR_COMMON_REQUEST_CONFLICT

ERROR_COMMON_AUTHENTICATION_REQUIRED

ERROR_COMMON_AUTHENTICATION_OAUTH_NONCE_EXPIRED

ERROR_COMMON_ACCESS_DENIED

ERROR_COMMON_SCHEMA_VALIDATION_FAILED

ERROR_COMMON_URL_PARAMETER_REQUIRED

ERROR_COMMON_URL_PARAMETER_VALIDATION_FAILED

ERROR_COMMON_URL_MULTIPLE_PARAMETERS_NOT_ALLOWED

ERROR_COMMON_URL_PARAMETER_NOT_SUPPORTED

ERROR_COMMON_NOT_IMPLEMENTED

ERROR_COMMON_SERVICE_UNAVAILABLE

ERROR_COMMON_INTERNAL_SERVER_ERROR

ERROR_COMMON_UNPROCESSABLE_ENTITY

ERROR_COMMON_INTERNAL_SERVER_ERROR_WITH_DETAILS

ERROR_COMMON_RESOURCE_NOT_FOUND

ERROR_COMMON_METHOD_NOT_ALLOWED

ERROR_COMMON_ACCEPT_TYPE_NOT_APPLICABLE

ERROR_COMMON_MEDIA_TYPE_UNSUPPORTED

ERROR_COMMON_BAD_REQUEST

ERROR_RESOURCE_NOT_SUPPORTED

ERROR_RESOURCE_NOT_FOUND

ERROR_RESOURCE_NOT_FOUND_FOR_MULTIPLE_PARAMETERS

ERROR_RESOURCE_VALIDATION

ERROR_REQUESTED_DATA_NOT_FOUND

ERROR_RESOURCE_NOT_UNIQUE

ERROR_RESOURCE_NO_LONGER_AVAILABLE

ERROR_DB_NOT_AVAILABLE

ERROR_CONTACT_DETAILS_MISSING

ERROR_INVALID_COORDINATES

ERROR_GEOCODING_FAILED

Method Detail

values

valueOf

value

fromValue