org.assistments.domain.exception

Class PersistableRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.assistments.domain.exception.PersistableRuntimeException

All Implemented Interfaces:

java.io.Serializable, HasUID, IsPersistable, SelfValidating

Direct Known Subclasses:

ClientException, ServerException

public abstract class PersistableRuntimeException
extends java.lang.Exception
implements IsPersistable

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistableRuntimeException(java.lang.String classType)
protected	PersistableRuntimeException(java.lang.String classType, java.lang.String uid)
protected	PersistableRuntimeException(java.lang.String classType, java.lang.String uid, java.lang.Throwable cause)
protected	PersistableRuntimeException(java.lang.String classType, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
void	addExtraField(java.lang.String key, java.lang.String value)
java.util.Map<java.lang.String,java.lang.String>	getExtraFields()
java.lang.String	getKey() Returns a key representing this persistable object in the following format: @<class type>/<uid>
java.lang.String	getMessage() Returns the error message
java.lang.String	getShortKey() Alias for HasUID.getUID()
java.lang.String	getTargetKey() Returns the Persistence Key of the object associated with this exception.
java.lang.String	getType() Returns, as a fully specified class name, the class type needed to store this persistable object.
java.lang.String	getUID() Returns the database UID for this persistable object.
ValidatorUtilities	getValidatorUtilities()
void	setExtraFields(java.util.Map<java.lang.String,java.lang.String> extraFields)
void	setMessage(java.lang.String message) Sets an error message into this exception.
void	setTargetKey(java.lang.String targetKey) Stores the Persistence Key of the object this exception applies to.
void	setValidatorUtilities(ValidatorUtilities vu)
java.lang.String	toString() Returns a string representation of this object.
void	validate() Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistableRuntimeException

protected PersistableRuntimeException(java.lang.String classType,
                                      java.lang.String uid)

PersistableRuntimeException

protected PersistableRuntimeException(java.lang.String classType)

PersistableRuntimeException

protected PersistableRuntimeException(java.lang.String classType,
                                      java.lang.String uid,
                                      java.lang.Throwable cause)

PersistableRuntimeException

protected PersistableRuntimeException(java.lang.String classType,
                                      java.lang.Throwable cause)

Method Detail

getMessage

public java.lang.String getMessage()

Returns the error message

Overrides:

getMessage in class java.lang.Throwable

setMessage

public void setMessage(java.lang.String message)

Sets an error message into this exception.

Parameters:

message - a short error message

getUID

public java.lang.String getUID()

Description copied from interface: HasUID

Returns the database UID for this persistable object.

Specified by:

getUID in interface HasUID

getShortKey

public java.lang.String getShortKey()

Description copied from interface: HasUID

Alias for HasUID.getUID()

Specified by:

getShortKey in interface HasUID

getType

public java.lang.String getType()

Description copied from interface: IsPersistable

Returns, as a fully specified class name, the class type needed to store this persistable object.

Specified by:

getType in interface IsPersistable

getKey

public java.lang.String getKey()

Description copied from interface: IsPersistable

Returns a key representing this persistable object in the following format:
@<class type>/<uid>

Specified by:

getKey in interface IsPersistable

See Also:

IsPersistable.getType(), org.assistments.domain.content.tutor.persistence.HasUID#getUID()

getTargetKey

public java.lang.String getTargetKey()

Returns the Persistence Key of the object associated with this exception.

setTargetKey

public void setTargetKey(java.lang.String targetKey)

Stores the Persistence Key of the object this exception applies to.

Parameters:

targetKey - Persistence Key of the object associated with this exception.

toString

public java.lang.String toString()

Description copied from interface: IsPersistable

Returns a string representation of this object.

Specified by:

toString in interface IsPersistable

Overrides:

toString in class java.lang.Throwable

validate

public void validate()
              throws ValidationException

Description copied from interface: SelfValidating

Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!

Specified by:

validate in interface SelfValidating

Throws:

ValidationException - if the data is invalid

setValidatorUtilities

public void setValidatorUtilities(ValidatorUtilities vu)

Specified by:

setValidatorUtilities in interface IsPersistable

getValidatorUtilities

public ValidatorUtilities getValidatorUtilities()

Specified by:

getValidatorUtilities in interface IsPersistable

addExtraField

public void addExtraField(java.lang.String key,
                          java.lang.String value)

getExtraFields

public java.util.Map<java.lang.String,java.lang.String> getExtraFields()

setExtraFields

public void setExtraFields(java.util.Map<java.lang.String,java.lang.String> extraFields)