com.netscape.pm.model
Interface IProcessDefinition

public interface IProcessDefinition

Defines a container for a set of static objects that represent the run-time composition of the application as designed from the Process Manager builder. The process definition contains the data, script and form dictionary, the process map and the form/role access control lists for the application. Each of the components available from this interface comprise part of the static description of the application used by the run-time engine to generate and execute work items.

A handle to the process definition can be obtained via the getProcessDefinition method off the IPMApplication interface.

See Also:

IPMApplication, IAccessControlManager, IConnector, IDataDictionary, IFormDictionary, IProcessMap, IRoleManager

Method Summary

IAccessControlManager	getAccessControlManager() Returns the access control manager defined for the current application.
IConnector	getConnector() Returns the connector container defined for the current application.
IDataDictionary	getDataDictionary() Returns the data dictionary defined for the current application.
IFormDictionary	getFormDictionary() Returns the form dictionary defined for the current application.
java.lang.String	getPriorityFieldName() Returns the name of the priority data field.
IProcessMap	getProcessMap() Returns the process map defined for the current application.
IRoleManager	getRoleManager() Returns the role manager defined for the current application.
java.lang.String	getTitleFieldName() Returns the name of the title data field.

Method Detail

getDataDictionary

public IDataDictionary getDataDictionary()

Returns the data dictionary defined for the current application. The data dictionary is the container for all the data fields available for use in the application.

Returns:

the data dictionary defined for the current application.

Since:

PAE 4.0

See Also:

IDataDictionary

getFormDictionary

public IFormDictionary getFormDictionary()

Returns the form dictionary defined for the current application. The form dictionary is the container for all the forms available for use in the application.

Returns:

the form dictionary defined for the current application.

Since:

PAE 4.0

See Also:

IFormDictionary

getProcessMap

public IProcessMap getProcessMap()

Returns the process map defined for the current application. The process map is the container for all the node elements defined in the application.

Returns:

the process map defined for the current application.

Since:

PAE 4.0

See Also:

IProcessMap

getAccessControlManager

public IAccessControlManager getAccessControlManager()

Returns the access control manager defined for the current application. The access control manager is the security/role-form resolution manager for the application.

Returns:

the access control manager defined for the current application.

Since:

PAE 4.0

See Also:

IAccessControlManager

getRoleManager

public IRoleManager getRoleManager()

Returns the role manager defined for the current application. The role manager is the container for all the roles defined in the application.

Returns:

the role manager defined for the current application.

Since:

PAE 4.0

See Also:

IRoleManager

getConnector

public IConnector getConnector()

Returns the connector container defined for the current application. The connector is best described as a global hashtable for storing custom resources to be made available across instances in the current application.

Returns:

the connector container defined for the current application.

Since:

PAE 4.0

See Also:

IConnector

getPriorityFieldName

public java.lang.String getPriorityFieldName()

Returns the name of the priority data field. The process instance priority value is derived from the value contained within this field.

Returns:

the name of the priority data field.

Since:

PM 6.0

See Also:

IProcessInstance.getPriority()

getTitleFieldName

public java.lang.String getTitleFieldName()

Returns the name of the title data field. The process instance title value is derived from the value contained within this field.

Returns:

the name of the title data field.

Since:

PM 6.0

See Also:

IProcessInstance.getTitle()