com.netscape.pm.model
Interface IDataDictionary

public interface IDataDictionary

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

See Also:

IDataElement, IProcessDefinition

Method Summary

java.util.Enumeration	fields() Returns an enumeration of all the fields defined in the data dictionary for the current application.
IDataElement	getDataElement(java.lang.String deName) Returns a handle to the specified data element.
java.util.Enumeration	getSearchableElements() Returns an enumeration of all the fields that have been marked as searchable in the data dictionary for the current application.

Method Detail

getDataElement

public IDataElement getDataElement(java.lang.String deName)
                            throws PMException

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

Parameters:

deName - the name of the data element to access

Returns:

the data element that corresponds to the specified name.

Throws:

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

Since:

PAE 4.0

See Also:

IDataElement

getSearchableElements

public java.util.Enumeration getSearchableElements()

Returns an enumeration of all the fields that have been marked as searchable in the data dictionary for the current application.

Returns:

java.util.Enumeration of IDataElement objects.

Since:

PAE 4.0

See Also:

IDataElement.canSearch()

fields

public java.util.Enumeration fields()

Returns an enumeration of all the fields defined in the data dictionary for the current application.

Returns:

java.util.Enumeration of IDataElement objects.

Since:

PAE 4.0

See Also:

IDataElement