oracle.jdeveloper.audit.bean

Class BeanCustomizer

java.lang.Object

oracle.jdeveloper.audit.bean.BeanCustomizer

Direct Known Subclasses:

ExtensionBeanCustomizer, MetricCustomizer, ObjectCustomizer, RuleCustomizer

public abstract class BeanCustomizer
extends java.lang.Object

A class which gives supplemental information about a bean class that a component displaying an instance of the bean class can use to improve its presentation. A customizer can provide null information for any or all properties: the component should first query the customizer for the most derived class and then query customizers for superclasses as needed.

See Also:

AuditProvider.getBeanCustomizers()

Constructor Summary

Constructors

Constructor and Description
BeanCustomizer()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	description(java.lang.Object bean, java.lang.String itemName) Gets the localized description for a property or property group of a bean, or null to defer to a superclass customizer.
PropertyDescriptor	descriptor(java.lang.Object bean, java.lang.String propertyName) Gets the descriptor for a property of a bean, or null to defer to a superclass customizer.
PropertyField	field(java.lang.Object bean, java.lang.String propertyName) Gets the PropertyField which should be used to display a property of a bean, or null to defer to a superclass customizer.
abstract java.lang.Class<?>	getType() The type which this customizer customizes.
java.lang.String[]	items(java.lang.Object bean, java.lang.String groupName) Gets an array of property and property group names for the properties of a bean, in display order, or null to defer to a superclass customizer.
java.lang.String	label(java.lang.Object bean, java.lang.String itemName) Gets the localized label for a property or property group of a bean, or null to defer to a superclass customizer.
java.lang.Boolean	modifiable(java.lang.Object bean, java.lang.String itemName) Gets whether a property or property group of the bean should be modifiable, or null to defer to a superclass customizer.
java.lang.Class	type(java.lang.Object bean, java.lang.String propertyName) Gets the type for a property of a bean, or null to defer to a superclass customizer.
java.lang.String	valid(java.lang.Object bean) Gets whether the properties of this bean are valid.
java.lang.Boolean	visible(java.lang.Object bean, java.lang.String itemName) Gets whether a property or property group of the bean should be visible, or null to defer to a superclass customizer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanCustomizer

public BeanCustomizer()

Method Detail

getType

public abstract java.lang.Class<?> getType()

The type which this customizer customizes.

visible

public java.lang.Boolean visible(java.lang.Object bean,
                        java.lang.String itemName)

Gets whether a property or property group of the bean should be visible, or null to defer to a superclass customizer. The default BeanCustomizer implementation returns null.

items

public java.lang.String[] items(java.lang.Object bean,
                       java.lang.String groupName)

Gets an array of property and property group names for the properties of a bean, in display order, or null to defer to a superclass customizer. One name can be "*" to indicate items from a superclass customizer or, ultimately, properties not named by any customizer. The default BeanCustomizer implementation returns null.

Parameters:

bean - the instance of the bean class being displayed

groupName - the name of a property group, or null for the notional top level group

Returns:

an array of Strings naming properties and property groups in display order, or null to indicate default ordering.

descriptor

public PropertyDescriptor descriptor(java.lang.Object bean,
                            java.lang.String propertyName)

Gets the descriptor for a property of a bean, or null to defer to a superclass customizer. The default BeanCustomizer implementation returns null.

type

public java.lang.Class type(java.lang.Object bean,
                   java.lang.String propertyName)

Gets the type for a property of a bean, or null to defer to a superclass customizer. The type returned must be assignable to the declared type of the property. The default BeanCustomizer implementation returns null.

label

public java.lang.String label(java.lang.Object bean,
                     java.lang.String itemName)

Gets the localized label for a property or property group of a bean, or null to defer to a superclass customizer. The default BeanCustomizer implementation returns null.

description

public java.lang.String description(java.lang.Object bean,
                           java.lang.String itemName)

Gets the localized description for a property or property group of a bean, or null to defer to a superclass customizer. The default BeanCustomizer implementation returns null.

field

public PropertyField field(java.lang.Object bean,
                  java.lang.String propertyName)

Gets the PropertyField which should be used to display a property of a bean, or null to defer to a superclass customizer. The default BeanCustomizer implementation returns null.

Returns:

a configured field instance, or null to use the default field for the property type.

modifiable

public java.lang.Boolean modifiable(java.lang.Object bean,
                           java.lang.String itemName)

Gets whether a property or property group of the bean should be modifiable, or null to defer to a superclass customizer. Invoked for each item when any property of the bean changes. The default BeanCustomizer implementation returns null.

valid

public java.lang.String valid(java.lang.Object bean)

Gets whether the properties of this bean are valid. Invoked when any property of the bean changes. The default BeanCustomizer implementation returns null.

Returns:

null if the properties are valid, or a localized explanatory string if not.