com.netscape.pm.model
Interface IPMElement

All Known Subinterfaces:

IDataElement, IFormElement, INodeElement, INotification, IPresentationElement, IRole, ITransition

All Known Implementing Classes:

BasicCustomField

public interface IPMElement

The base interface for all Process Manager configurable elements. All objects that implement this interface have some representation in the builder, for instance a node element or a data field. The primary function of this interface is to provide a simple means of accessing the configuration properties established by the designer from the builder.

See Also:

IProcessDefinition

Method Summary

java.util.Hashtable	dumpState() Returns the properties of the configuration element in a hashtable.
java.lang.String	getDescription() Returns the description of the element.
java.lang.String	getName() Returns the name of the element.
IPMElement	getParent() Returns the parent element of this configuration element.
java.lang.String	getPrettyName() Returns the prettyname of the element.
java.lang.Object	getProperty(java.lang.String propName) Returns the value associated with a particular configuration property.
boolean	isLocked() Returns true if the configuration element has been locked.
void	lockObject() Locks the configuration element from any further changes to its configuration.
void	postCreation(IProcessDefinition pd) This method is invoked once the application has been loaded.
void	setParent(IPMElement elem) Sets the parent element of this configuration element.
void	setProperties(java.util.Hashtable entry) Initializes the configuration element with the properties stored in the repository.
java.lang.String	toString() Returns the string representation of the configuration element.

Method Detail

setProperties

public void setProperties(java.util.Hashtable entry)
                   throws PMException

Initializes the configuration element with the properties stored in the repository. In the process manager world, every element created from the builder contains a set of customizable properties. Invoking this method with this set of properties in effect transforms a base PMElement into a more specific version of a configuration element (such as a node element or a data field).

Users should note that as a part of the configuration element creation procedure, this object is locked to prevent run-time changes to its definition; hence, any calls to this method during run-time will result in an exception being thrown.

Parameters:

entry - the properties to associate this element with

Throws:

PMException - if there is a problem with configuring this element with the properties provided.

Since:

PAE 4.0

getProperty

public java.lang.Object getProperty(java.lang.String propName)

Returns the value associated with a particular configuration property.

Parameters:

propName - the name of the configuration property

Returns:

the value associated with the configuration property; null if no such property has been defined.

Since:

PAE 4.0

getName

public java.lang.String getName()

Returns the name of the element.

Returns:

the name of the element.

Since:

PAE 4.0

getPrettyName

public java.lang.String getPrettyName()

Returns the prettyname of the element. As of PAE 4.0, the name and prettyname of an element are identical.

Returns:

the prettyname of the element.

Since:

PAE 4.0

getDescription

public java.lang.String getDescription()

Returns the description of the element.

Returns:

the description of the element.

Since:

PAE 4.0

postCreation

public void postCreation(IProcessDefinition pd)
                  throws PMException

This method is invoked once the application has been loaded. This method is meant to act as a hook to resolve module dependencies which cannot be resolved during application initialization.

Users should note that as a part of the configuration element creation procedure, this object is locked to prevent run-time changes to its definition; hence, any calls to this method during run-time will result in an exception being thrown.

Parameters:

pd - the process definition for the application

Throws:

PMException - if there is a problem with the post creation phase of this configuration element; or if this object has been locked

Since:

PAE 4.0

See Also:

IProcessDefinition

setParent

public void setParent(IPMElement elem)

Sets the parent element of this configuration element. Each configuration element is bound to a chain of parent elements, for instance each node element is bound to the process map that contains it.

Users should note that as a part of the configuration element creation procedure, this object is locked to prevent run-time changes to its definition; hence, any calls to this method during run-time will result in an exception being thrown.

Parameters:

elem - the parent element of this element

Since:

PAE 4.0

getParent

public IPMElement getParent()

Returns the parent element of this configuration element. Each configuration element is bound to a chain of parent elements, for instance each node element is bound to the process map that contains it.

Users will probably never need to invoke this method. It has been included in this interface as a convenience method for internal engine functionality.

Returns:

the parent element of this element.

Since:

PAE 4.0

lockObject

public void lockObject()

Locks the configuration element from any further changes to its configuration. If any mutators are invoked on this method after the element has been locked, an exception will be thrown.

Since:

PM 6.0

isLocked

public boolean isLocked()

Returns true if the configuration element has been locked.

Returns:

true if the element has been locked; false otherwise.

Since:

PM 6.0

toString

public java.lang.String toString()

Returns the string representation of the configuration element.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the configuration element.

Since:

PAE 4.0

dumpState

public java.util.Hashtable dumpState()

Returns the properties of the configuration element in a hashtable. This method was designed to be used as a debugging tool; it presents users with a simple means of checking the current state of a configuration element.

Returns:

the properties of the configuration element.

Since:

PM 6.0