com.netscape.pm.model
Interface IFormDictionary

public interface IFormDictionary

Defines an object that will contain all of the forms defined for the current application; that is, all the forms visible from the form dictionary folder in the builder's application tree view. The object that implements IFormDictionary is part of the application's process definition; a handle to the form dictionary can be obtained via the IProcessDefinition interface.

See Also:

IFormElement, IProcessDefinition

Method Summary

java.util.Enumeration	forms() Returns an enumeration of all the forms defined in the form dictionary for the current application.
IFormElement	getFormElement(java.lang.String feName) Returns a handle to the specified form element.

Method Detail

getFormElement

public IFormElement getFormElement(java.lang.String feName)
                            throws PMException

Returns a handle to the specified form element. The name of the form is its common name, that is the label applied to the form from the application tree view folder in the builder.

Parameters:

feName - the name of the form element to access

Returns:

the form element that corresponds to the specified name.

Throws:

PMException - if there is no such form element defined in the form dictionary for the current application.

Since:

PAE 4.0

See Also:

IFormElement

forms

public java.util.Enumeration forms()

Returns an enumeration of all the forms defined in the form dictionary for the current application.

Returns:

java.util.Enumeration of IFormElement objects.

Since:

PAE 4.0

See Also:

IFormElement