EntityValidity (PageSeeder Bridge 0.8.3 API)

java.lang.Object
- java.lang.Enum<EntityValidity>
- - org.pageseeder.bridge.EntityValidity

All Implemented Interfaces:

Serializable, Comparable<EntityValidity>
```
public enum EntityValidity
extends Enum<EntityValidity>
```
Possible states for entity validity.

Version:

0.1.0

Author:

Christophe Lauret

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DETAIL_FIELD_VALUE_IS_TOO_LONG` The value of the details field in the membership is too long, max allowed is 100.
`DOCUMENT_DOCID_IS_TOO_LONG` The document ID is too long, max allowed is 100.
`DOCUMENT_IS_A_FOLDER` The URI is folder not a document and therefore cannot be represented as a `PSDocument` instance.
`DOCUMENT_LABELS_ARE_TOO_LONG` The document labels are too long.
`DOCUMENT_TITLE_IS_TOO_LONG` The document title is too long, max allowed is 250.
`FOLDER_IS_NOT_A_FOLDER` The URI is a document not a folder and therefore cannot be represented as a `PSFolder` instance.
`GROUP_DESCRIPTION_IS_TOO_LONG` The description of the group is too long, max allowed is 250.
`GROUP_DETAILTYPE_IS_TOO_LONG` The detail type of the group is too long, max allowed is 150.
`GROUP_NAME_IS_INVALID` The name of the group is either reserved or uses and invalid character.
`GROUP_NAME_IS_TOO_LONG` The full name of the group is too long, max allowed is 60.
`GROUP_OWNER_IS_TOO_LONG` The full name of the group is too long, max allowed is 100.
`GROUP_TEMPLATE_IS_TOO_LONG` The template of the group is too long, max allowed is 60.
`IMAGE_XREF_TARGET_NOT_IMAGE` The XRef of type IMAGE must target an image.
`MEMBER_EMAIL_IS_TOO_LONG` The email address of the member is too long, max allowed is 100.
`MEMBER_FIRSTNAME_IS_TOO_LONG` The first name of the member is too long, max allowed is 20.
`MEMBER_SURNAME_IS_TOO_LONG` The last name of the member is too long, max allowed is 20.
`MEMBER_USERNAME_IS_TOO_LONG` The username of the member is too long, max allowed is 100.
`OK` The entity appears valid.

Method Summary

Methods
Modifier and Type	Method and Description
`static EntityValidity`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EntityValidity[]`	`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
  - OK
```
public static final EntityValidity OK
```
    The entity appears valid.
  - DOCUMENT_DOCID_IS_TOO_LONG
```
public static final EntityValidity DOCUMENT_DOCID_IS_TOO_LONG
```
    The document ID is too long, max allowed is 100.
  - DOCUMENT_TITLE_IS_TOO_LONG
```
public static final EntityValidity DOCUMENT_TITLE_IS_TOO_LONG
```
    The document title is too long, max allowed is 250.
  - DOCUMENT_LABELS_ARE_TOO_LONG
```
public static final EntityValidity DOCUMENT_LABELS_ARE_TOO_LONG
```
    The document labels are too long.
  - DOCUMENT_IS_A_FOLDER
```
public static final EntityValidity DOCUMENT_IS_A_FOLDER
```
    The URI is folder not a document and therefore cannot be represented as a PSDocument instance.
  - FOLDER_IS_NOT_A_FOLDER
```
public static final EntityValidity FOLDER_IS_NOT_A_FOLDER
```
    The URI is a document not a folder and therefore cannot be represented as a PSFolder instance.
  - GROUP_NAME_IS_TOO_LONG
```
public static final EntityValidity GROUP_NAME_IS_TOO_LONG
```
    The full name of the group is too long, max allowed is 60.
  - GROUP_OWNER_IS_TOO_LONG
```
public static final EntityValidity GROUP_OWNER_IS_TOO_LONG
```
    The full name of the group is too long, max allowed is 100.
  - GROUP_DESCRIPTION_IS_TOO_LONG
```
public static final EntityValidity GROUP_DESCRIPTION_IS_TOO_LONG
```
    The description of the group is too long, max allowed is 250.
  - GROUP_DETAILTYPE_IS_TOO_LONG
```
public static final EntityValidity GROUP_DETAILTYPE_IS_TOO_LONG
```
    The detail type of the group is too long, max allowed is 150.
  - GROUP_TEMPLATE_IS_TOO_LONG
```
public static final EntityValidity GROUP_TEMPLATE_IS_TOO_LONG
```
    The template of the group is too long, max allowed is 60.
  - GROUP_NAME_IS_INVALID
```
public static final EntityValidity GROUP_NAME_IS_INVALID
```
    The name of the group is either reserved or uses and invalid character.
  - MEMBER_FIRSTNAME_IS_TOO_LONG
```
public static final EntityValidity MEMBER_FIRSTNAME_IS_TOO_LONG
```
    The first name of the member is too long, max allowed is 20.
  - MEMBER_SURNAME_IS_TOO_LONG
```
public static final EntityValidity MEMBER_SURNAME_IS_TOO_LONG
```
    The last name of the member is too long, max allowed is 20.
  - MEMBER_USERNAME_IS_TOO_LONG
```
public static final EntityValidity MEMBER_USERNAME_IS_TOO_LONG
```
    The username of the member is too long, max allowed is 100.
  - MEMBER_EMAIL_IS_TOO_LONG
```
public static final EntityValidity MEMBER_EMAIL_IS_TOO_LONG
```
    The email address of the member is too long, max allowed is 100.
  - DETAIL_FIELD_VALUE_IS_TOO_LONG
```
public static final EntityValidity DETAIL_FIELD_VALUE_IS_TOO_LONG
```
    The value of the details field in the membership is too long, max allowed is 100.
  - IMAGE_XREF_TARGET_NOT_IMAGE
```
public static final EntityValidity IMAGE_XREF_TARGET_NOT_IMAGE
```
    The XRef of type IMAGE must target an image.
- Method Detail
  - values
```
public static EntityValidity[] 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 (EntityValidity c : EntityValidity.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EntityValidity 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 EntityValidity

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OK

DOCUMENT_DOCID_IS_TOO_LONG

DOCUMENT_TITLE_IS_TOO_LONG

DOCUMENT_LABELS_ARE_TOO_LONG

DOCUMENT_IS_A_FOLDER

FOLDER_IS_NOT_A_FOLDER

GROUP_NAME_IS_TOO_LONG

GROUP_OWNER_IS_TOO_LONG

GROUP_DESCRIPTION_IS_TOO_LONG

GROUP_DETAILTYPE_IS_TOO_LONG

GROUP_TEMPLATE_IS_TOO_LONG

GROUP_NAME_IS_INVALID

MEMBER_FIRSTNAME_IS_TOO_LONG

MEMBER_SURNAME_IS_TOO_LONG

MEMBER_USERNAME_IS_TOO_LONG

MEMBER_EMAIL_IS_TOO_LONG

DETAIL_FIELD_VALUE_IS_TOO_LONG

IMAGE_XREF_TARGET_NOT_IMAGE

Method Detail

values

valueOf