oracle.jdeveloper.offlinedb.userprops

Class AbstractUserPropertyValidator

java.lang.Object

oracle.jdeveloper.offlinedb.userprops.AbstractUserPropertyValidator

All Implemented Interfaces:

OfflineDBValidationManager.Validator

public abstract class AbstractUserPropertyValidator
extends java.lang.Object
implements OfflineDBValidationManager.Validator

An abstract implementation of OfflineDBValidationManager.Validator that can be extended to provide custom validation of User Properties.

Subclasses should be registered in the offline-database-hook.

Constructor Summary

Constructors

Constructor and Description
AbstractUserPropertyValidator()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	getPropertyNames(OfflineDBObjectProvider pro, DBObject dbo) Subclasses can return a list of user defined property names that they wish to validate for the given DBObject.
void	validateObject(OfflineDBObjectProvider pro, DBObject original, DBObject update, java.lang.String property) Validates the given object change for the given provider.
abstract void	validateUserPropertyValue(OfflineDBObjectProvider pro, DBObject original, DBObject update, java.lang.String userPropertyName, java.lang.String userPropertyValue) Implementations of this method will be called to allow validation of User Property Values.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserPropertyValidator

public AbstractUserPropertyValidator()

Method Detail

validateObject

public final void validateObject(OfflineDBObjectProvider pro,
                                 DBObject original,
                                 DBObject update,
                                 java.lang.String property)
                          throws ValidationException

Description copied from interface: OfflineDBValidationManager.Validator

Validates the given object change for the given provider.

Specified by:

validateObject in interface OfflineDBValidationManager.Validator

Parameters:

pro - the offline database the validation is for

original - the original object if this is an update, or null if it is a create

update - the object definition to be validated - i.e. the new version for an update, or the new object that's being created.

property - the specific property to validate, or null if all properties are the be validated.

Throws:

ValidationException

getPropertyNames

protected java.util.List<java.lang.String> getPropertyNames(OfflineDBObjectProvider pro,
                                                            DBObject dbo)

Subclasses can return a list of user defined property names that they wish to validate for the given DBObject.

Returning null, or an empty list (the default), will cause validateUserPropertyValue to be called for all User Defined Properties applicable to the given DBObject.

Parameters:

pro - The Offline Database Provider

dbo - The object whose properties are being validated

validateUserPropertyValue

public abstract void validateUserPropertyValue(OfflineDBObjectProvider pro,
                                               DBObject original,
                                               DBObject update,
                                               java.lang.String userPropertyName,
                                               java.lang.String userPropertyValue)
                                        throws ValidationException

Implementations of this method will be called to allow validation of User Property Values.

Parameters:

pro - The Offline Database Provider

original - The original object if an update is being peformed or null if a new object is being created.

update - The updated (or new) object whose properties are being validated

userPropertyName - The name of the User Property

userPropertyValue - The value of the user Property

Throws:

ValidationException