org.pageseeder.bridge

Class InvalidEntityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.pageseeder.bridge.APIException

org.pageseeder.bridge.InvalidEntityException

All Implemented Interfaces:

Serializable

public final class InvalidEntityException
extends APIException

Class of exceptions used for when a PageSeeder entity cannot be stored in PageSeeder because it is considered invalid.

This exception should be thrown when the intrinsic attributes of an entity are known to violate one of the constraints on a PageSeeder.

Examples: an invalid email address, a string value exceeding a maximum length.

Note: this exception may not be appropriate for when extrinsic constraints are violated for example, for unique identifier.

Author:

Christophe Lauret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidEntityException(Class<? extends PSEntity> entity, EntityValidity validity) Create a new exception.

Method Summary

Methods

Modifier and Type	Method and Description
Class<? extends PSEntity>	getEntityType()
EntityValidity	getValidity()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidEntityException

public InvalidEntityException(Class<? extends PSEntity> entity,
                      EntityValidity validity)

Create a new exception.

Parameters:

entity - The entity that is invalid.

validity - The entity validity status.

Method Detail

getEntityType

public Class<? extends PSEntity> getEntityType()

Returns:

the kind of entity

getValidity

public EntityValidity getValidity()

Returns:

the validity