ClientError (Hippo Site Toolkit API 14.2.0 API)

java.lang.Object
- java.lang.Enum<ClientError>
- - org.hippoecm.hst.pagecomposer.jaxrs.services.exceptions.ClientError

All Implemented Interfaces:

Serializable, Comparable<ClientError>
```
public enum ClientError
extends Enum<ClientError>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CHILD_MOUNT_EXISTS` Client requests to delete a hst:mount node, but it contains children node(s) of type hst:mount
`DOCUMENT_CREATION_FAILED`
`FORBIDDEN`
`INVALID_MOVE_TO_SELF_OR_DESCENDANT`
`INVALID_NAME`
`INVALID_NODE_TYPE`
`INVALID_PATH_INFO`
`INVALID_URL`
`INVALID_UUID`
`INVALID_VERSION_STAMP` When trying to lock a node that has in the mean time been locked, changed and published by someone else, this error can be used to return.
`ITEM_ALREADY_LOCKED` Represents a situation where a client tries to mutate an item that has already been locked by another user
`ITEM_CANNOT_BE_CLONED`
`ITEM_CHANGED` Represents a situation where a client tries to mutate an item that has been changed by another user
`ITEM_EXISTS` Client requests to create a new item with the given Id that already exists
`ITEM_EXISTS_OUTSIDE_WORKSPACE` Represents a situation where a client tries to add an item that already exist outside of the workspace with the same name.
`ITEM_NAME_NOT_UNIQUE` Represents a situation where a client tries to add a child node to a parent that does not allow same name siblings.
`ITEM_NAME_NOT_UNIQUE_IN_ROOT` Represents a situation where a client tries to add a child node to a parent that does not allow same name siblings, where the parent represents the root of a certain node hierarchy.
`ITEM_NO_NAME` Represents a situation where a client tries to add an item that has no name (title in case of menu)
`ITEM_NOT_CHILD_OF_PARENT`
`ITEM_NOT_CORRECT_LOCATION`
`ITEM_NOT_FOUND`
`ITEM_NOT_IN_PREVIEW`
`NO_PREVIEW_CONFIGURATION`
`UNKNOWN`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ClientError`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ClientError[]`	`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
  - ITEM_NAME_NOT_UNIQUE
```
public static final ClientError ITEM_NAME_NOT_UNIQUE
```
    Represents a situation where a client tries to add a child node to a parent that does not allow same name siblings.
  - ITEM_NAME_NOT_UNIQUE_IN_ROOT
```
public static final ClientError ITEM_NAME_NOT_UNIQUE_IN_ROOT
```
    Represents a situation where a client tries to add a child node to a parent that does not allow same name siblings, where the parent represents the root of a certain node hierarchy.
  - ITEM_ALREADY_LOCKED
```
public static final ClientError ITEM_ALREADY_LOCKED
```
    Represents a situation where a client tries to mutate an item that has already been locked by another user
  - ITEM_CHANGED
```
public static final ClientError ITEM_CHANGED
```
    Represents a situation where a client tries to mutate an item that has been changed by another user
  - ITEM_EXISTS_OUTSIDE_WORKSPACE
```
public static final ClientError ITEM_EXISTS_OUTSIDE_WORKSPACE
```
    Represents a situation where a client tries to add an item that already exist outside of the workspace with the same name.
  - ITEM_NO_NAME
```
public static final ClientError ITEM_NO_NAME
```
    Represents a situation where a client tries to add an item that has no name (title in case of menu)
  - INVALID_URL
```
public static final ClientError INVALID_URL
```
  - INVALID_PATH_INFO
```
public static final ClientError INVALID_PATH_INFO
```
  - ITEM_CANNOT_BE_CLONED
```
public static final ClientError ITEM_CANNOT_BE_CLONED
```
  - ITEM_NOT_IN_PREVIEW
```
public static final ClientError ITEM_NOT_IN_PREVIEW
```
  - NO_PREVIEW_CONFIGURATION
```
public static final ClientError NO_PREVIEW_CONFIGURATION
```
  - ITEM_NOT_CORRECT_LOCATION
```
public static final ClientError ITEM_NOT_CORRECT_LOCATION
```
  - ITEM_NOT_FOUND
```
public static final ClientError ITEM_NOT_FOUND
```
  - ITEM_NOT_CHILD_OF_PARENT
```
public static final ClientError ITEM_NOT_CHILD_OF_PARENT
```
  - INVALID_UUID
```
public static final ClientError INVALID_UUID
```
  - INVALID_MOVE_TO_SELF_OR_DESCENDANT
```
public static final ClientError INVALID_MOVE_TO_SELF_OR_DESCENDANT
```
  - INVALID_NODE_TYPE
```
public static final ClientError INVALID_NODE_TYPE
```
  - INVALID_VERSION_STAMP
```
public static final ClientError INVALID_VERSION_STAMP
```
    When trying to lock a node that has in the mean time been locked, changed and published by someone else, this error can be used to return.
  - DOCUMENT_CREATION_FAILED
```
public static final ClientError DOCUMENT_CREATION_FAILED
```
  - INVALID_NAME
```
public static final ClientError INVALID_NAME
```
  - ITEM_EXISTS
```
public static final ClientError ITEM_EXISTS
```
    Client requests to create a new item with the given Id that already exists
  - CHILD_MOUNT_EXISTS
```
public static final ClientError CHILD_MOUNT_EXISTS
```
    Client requests to delete a hst:mount node, but it contains children node(s) of type hst:mount
  - FORBIDDEN
```
public static final ClientError FORBIDDEN
```
  - UNKNOWN
```
public static final ClientError UNKNOWN
```
- Method Detail
  - values
```
public static ClientError[] 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 (ClientError c : ClientError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ClientError 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

Enum ClientError

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ITEM_NAME_NOT_UNIQUE

ITEM_NAME_NOT_UNIQUE_IN_ROOT

ITEM_ALREADY_LOCKED

ITEM_CHANGED

ITEM_EXISTS_OUTSIDE_WORKSPACE

ITEM_NO_NAME

INVALID_URL

INVALID_PATH_INFO

ITEM_CANNOT_BE_CLONED

ITEM_NOT_IN_PREVIEW

NO_PREVIEW_CONFIGURATION

ITEM_NOT_CORRECT_LOCATION

ITEM_NOT_FOUND

ITEM_NOT_CHILD_OF_PARENT

INVALID_UUID

INVALID_MOVE_TO_SELF_OR_DESCENDANT

INVALID_NODE_TYPE

INVALID_VERSION_STAMP

DOCUMENT_CREATION_FAILED

INVALID_NAME

ITEM_EXISTS

CHILD_MOUNT_EXISTS

FORBIDDEN

UNKNOWN

Method Detail

values

valueOf