ValidateMethod Interface

com.bea.control
ValidateMethod Interface

public interface ValidateMethod

The ValidateMethod interface provides methods with which you can validate a control method. The WebLogic Workshop IDE calls these methods in your implementation of this interface. To expose your implementation to the IDE, you specify the implementation with the method-validator attribute of the <control-tags> element in the control's tags XML file.

Note: The ValidateMethod interface is part of the WebLogic Workshop Control Development Kit. The Control Development Kit is for users who are creating advanced controls. It is available in your BEA installation in the following directory: BEA_HOME\weblogic81\samples\workshop\ControlDevKit\

Method Summary

public Issue[]
validateDuringCompile(String methodName, boolean callback, String returnType, Map parameters, Map context)
Provides a way for control method declarations to be validated during compilation, and for you to display specific information in Source View for invalid methods.
public Issue[]
validateDuringEdit(String methodName, boolean callback, String returnType, Map parameters)
Not yet supported.

Method Detail

validateDuringCompile(String, boolean, String, Map, Map) Method

public Issue[] validateDuringCompile(String methodName, 
                                   boolean callback, 
                                   String returnType, 
                                   Map parameters, 
                                   Map context)
Provides a way for control method declarations to be validated during compilation, and for you to display specific information in Source View for invalid methods. This method is called by the IDE under many circumstances, including attempts by the control's user to build a component that contains the control. Invalid methods will be displayed in Source View with a red underline.

Parameters

methodName
The name of the method being validated.
callback
true if the method is a callback; otherwise, false.
returnType
The type returned by this method.
parameters
Map where the key is the parameter name, and the value is the parameter type (Mark -- param value?).
context
State that the control author can use to accumulate information during validation.

Returns

An array of issues. If there are no issues the array should be empty.

validateDuringEdit(String, boolean, String, Map) Method

public Issue[] validateDuringEdit(String methodName, 
                                boolean callback, 
                                String returnType, 
                                Map parameters)
Not yet supported.