PreferencesValidator - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.portlet
Interface PreferencesValidator

All Known Implementing Classes:: CreateASingleInstanceOfValidatorValidator, InvalidationCancelsStoreValidator, ValidationStoresValidator

public interface PreferencesValidator

The PreferencesValidator allows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.

The portlet container invokes the validate method as part of the invocation of the store method of the PortletPreferences.

Version:: $Revision: 5441 $
Author:: Julien Viet

Method Summary

void validate(PortletPreferences preferences)
If the preferences values are successfully validated the call to this method must finish gracefully.

Method Detail

validate

public void validate(PortletPreferences preferences)
              throws ValidatorException

If the preferences values are successfully validated the call to this method must finish gracefully. Otherwise it must throw a ValidatorException.

Parameters:: preferences - preferences to validate
Throws:: ValidatorException - if the given preferences contains invalid settings