bea.com | products | dev2dev | support | askBEA

Download Docs | Site Map | Glossary
Search

Programming BPM Plug-Ins

Plug-In Value Object Summary

This appendix describes the BPM plug-in value (or Info) objects and their methods. It includes the following topics:

- ActionCategoryInfo Object

- ActionInfo Object

- CategoryInfo Object

- ConfigurationData Object

- ConfigurationInfo Object

- DoneInfo Object

- EventHandlerInfo Object

- EventInfo Object

- FieldInfo Object

- FunctionInfo Object

- HelpSetInfo Object

- InfoObject Object

- PluginCapabilitiesInfo Object

- PluginDependency Object

- PlugInfo Object

- StartInfo Object

- TemplateDefinitionPropertiesInfo Object

- TemplateNodeInfo Object

- TemplatePropertiesInfo Object

- VariableTypeInfo Object

For more information about defining and accessing value object information, see Using Plug-In Value Objects.

ActionCategoryInfo Object

The com.bea.wlpi.common.plugin.ActionCategoryInfo object maintains plug-in action or action category information.

ActionCategoryInfo is the abstract base class for the following objects:

- com.bea.wlpi.common.plugin.ActionInfo

- com.bea.wlpi.common.plugin.CategoryInfo

The ActionCategoryInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new ActionCategoryInfo object:

>     public ActionCategoryInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       int parentSystemID,
>       java.lang.String[] classNames
>     )

The following table describes the ActionCategoryInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-1 ActionCategoryInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Action or action category ID. | ID | public int getID()
Localized name of the action or action category. | name | public java.lang.String getName()
Localized description of the action or action category. | description | public java.lang.String getDescription()
ID of the parent category that identifies the action category in the action tree. The ID can be set to one of the following values: ID_EXCEPTION: Exception Handling Actions category in the Studio. ID_INTEGRATION: Integration Actions category in the Studio. ID_MISCELLANEOUS: Miscellaneous Actions category in the Studio. ID_NEW: Initial category. ID_TASK: Task Actions category in the Studio. ID_WORKFLOW: Workflow Actions category in the Studio. A new action category that does not have access to the parent system ID must use ID_NEW. For example, ID_NEW must be used to add: New category under the root of the tree. Subcategory of a new category with a system ID that has not yet been generated by the Plug-in Manager. Once the plug-in identifies a parent category, it can retrieve its system ID via the getSystemID() method. | parentSystemID | public int getParentSystemID()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the KEY_* values provided by the subclass. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.ActionCategoryInfo Javadoc.

ActionInfo Object

The com.bea.wlpi.common.plugin.ActionInfo object maintains plug-in action information.

ActionCategoryInfo is the abstract base class for the ActionInfo object.

The ActionInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructors to create a new ActionInfo object:

>     public ActionInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       int parentSystemID,
>       int actionStateMask,
>       int actionStateTrans,
>       java.lang.String[] subActionLabels,
>       java.lang.String[] classNames
>     )

>     public ActionInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       int parentSystemID,
>       int actionStateMask,
>       java.lang.String[] classNames
>     )

The following table describes the ActionInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined.

Table B-2 ActionInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Action ID. | ID | public int getID()
Localized name of the action. | name | public java.lang.String getName()
Localized description of the action. | description | public java.lang.String getDescription()
Byte array representation of the graphical image (icon) for this plug-in, used by the Studio to represent this action when interface view is enabled. For more information about generating the byte array representation, see InfoObject Object. | iconByteArray | public javax.swing.Icon getIcon() public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
ID of the parent category that identifies the action category in the action tree. The ID can be set to one of the following values: ID_EXCEPTION: Exception Handling Actions category in the Studio. ID_INTEGRATION: Integration Actions category in the Studio. ID_MISCELLANEOUS: Miscellaneous Actions category in the Studio ID_NEW: Initial category. ID_TASK: Task Actions category in the Studio. ID_WORKFLOW: Workflow Actions category in the Studio. A new action category that does not have access to the parent system ID must use ID_NEW. For example, ID_NEW must be used to add: New category under the root of the tree. Subcategory of a new category with a system ID that has not yet been generated by the Plug-in Manager. Once the plug-in identifies a parent category, it can retrieve its system ID via the getSystemID() method. | parentSystemID | public int getParentSystemID()
Bit mask describing the action states in which this action is valid. This value is formed by performing a bitwise OR of the specified values. The bit mask can be set to one or more of the following values to specify when the action is valid: ACTION_STATE_ALL: Action is valid for all action states. ACTION_STATE_COMMIT: Action is valid in an exception handler. ACTION_STATE_COMMIT_ASYNC: Action is valid as an asynchronously executed subaction in an exception handler commit path. ACTION_STATE_COMMIT_SYNC: Action is valid as a synchronously executed subaction in an exception handler commit path. ACTION_STATE_NODE: Action is valid in a node. ACTION_STATE_NODE_ASYNC: Action is valid as an asynchronously executed subaction in a node. ACTION_STATE_NODE_SYNC: Action is valid as a synchronously executed subaction in a node. ACTION_STATE_ROLLBACK: Action is valid in an exception handler rollback path. ACTION_STATE_ROLLBACK_ASYNC: Action is valid as an asynchronously executed subaction in an exception handler rollback path. ACTION_STATE_ROLLBACK_SYNC: Action is valid as a synchronously executed subaction in an exception handler rollback path. | actionStateMask | public boolean isValidActionState (int actionStateMask)
Action state transition that results from executing the action's subactions. The state can be set to one of the following values: ACTION_STATE_TRANS_NONE: Action has no subactions. ACTION_STATE_TRANS_ASYNC: Action has subactions that system invokes asynchronously. ACTION_STATE_ROLLBACK_SYNC: Action has subactions that system invokes synchronously. | actionStateTrans | public int getActionStateTrans()
Localized action list labels. | subActionLabels | public java.lang.String[] getSubActionLabels()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_ACTION: Key value specifying the com.bea.wlpi.server.plugin.PluginAction implementation class name. KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginActionData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginActionPanel implementation class name. | classNames | public java.lang.Object getClass(int key)

For more information, see the com.bea.wlpi.common.plugin.ActionInfo Javadoc.

CategoryInfo Object

The com.bea.wlpi.common.plugin.CategoryInfo object maintains information about the plug-in action category.

ActionCategoryInfo is the abstract base class for the CategoryInfo object.

The CategoryInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new CategoryInfo object:

>     public CategoryInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       int parentSystemID,
>       com.bea.wlpi.common.plugin.ActionCategoryInfo[] subNodes
>     )

The following table describes the ActionCategoryInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-3 CategoryInfo Object Information

Object Information | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName() | N/A
Action category ID. | ID | public int getID() | N/A
Localized name of the action category. | name | public java.lang.String getName() | N/A
Localized description of the action category. | description | public java.lang.String getDescription() | N/A
ID of the parent category that identifies the category in the action tree. The ID can be set to one of the following values: ID_EXCEPTION: Exception Handling Actions category in the Studio. ID_INTEGRATION: Integration Actions category in the Studio. ID_MISCELLANEOUS: Miscellaneous Actions category in the Studio. ID_NEW: Initial category. ID_TASK: Task Actions category in the Studio. ID_WORKFLOW: Workflow Actions category in the Studio. A new action category that does not have access to the parent system ID must use ID_NEW. For example, ID_NEW must be used to add: New category under the root of the tree. Subcategory of a new category with a system ID that has not yet been generated by the Plug-in Manager. Once the plug-in identifies a parent category, it can retrieve its system ID via the getSystemID() method. | parentSystemID | public int getParentSystemID() | N/A
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the KEY_* values provided by the subclass. | subNodes | public com.bea.wlpi.common.plugin. ActionCategoryInfo[] getSubnodes() | public void addSubNode(com.bea.wlpi.common.plugin. ActionCategoryInfo node)
Plug-in system ID. | N/A | public int getSystemID() | public int setSystemID(int systemID)

Note: In addition to the methods defined in the previous table, the following method recursively searches the action category and its subcategories to locate the category with a matching system ID.

For more information, see the com.bea.wlpi.common.plugin.CategoryInfo Javadoc.

ConfigurationData Object

The com.bea.wlpi.common.plugin.ConfigurationData object maintains plug-in configuration information.

You can use the following constructor to create a new ConfigurationData object:

>     public ConfigurationData(
>       java.lang.String pluginName,
>       com.bea.wlpi.common.VersionInfo version,
>       int status,
>       int startMode,
>       java.lang.String xml
>     )

The following table describes the ConfigurationData object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-4 ConfigurationData Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in version. | version | public com.bea.wlpi.common.VersionInfo getVersion()
Plug-in status. | status | public int getStatus()
Plug-in start mode. | startMode | public int getStartMode()
XML configuration document. | xml | public java.lang.String getXML()

For more information, see the com.bea.wlpi.common.plugin.ConfigurationData Javadoc.

ConfigurationInfo Object

The com.bea.wlpi.common.plugin.ConfigurationInfo object maintains plug-in configuration information.

The ConfigurationInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new ConfigurationInfo object:

>     public ConfigurationInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String description,
>       java.lang.String[] classNames
>     )

The following table describes the ConfigurationInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-5 ConfigurationInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Plug-in description. | description | public int getStatus()
Plug-in start mode. | startMode | public int getStartMode()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.ConfigurationInfo Javadoc.

DoneInfo Object

The com.bea.wlpi.common.plugin.DoneInfo object maintains information about a plug-in Done node.

The DoneInfo class extends the following classes:

- com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object

- com.bea.wlpi.common.plugin.TemplateNodeInfo class, as defined in TemplateNodeInfo Object

You can use the following constructor to create a new DoneInfo object:

>     public DoneInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       java.lang.String[] classNames
>     )

The following table describes the ConfigurationInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-6 DoneInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the Done node. | name | public java.lang.String getName()
Localized description of the Done node. | description | public java.lang.String getDescription()
Byte array representation of the graphical image (icon) for this plug-in, used by the Studio to represent this action when interface view is enabled. For more information about generating the byte array representation, see InfoObject Object. | iconByteArray | public javax.swing.Icon getIcon() public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. KEY_DONE: Key value specifying the com.bea.wlpi.server.plugin.PluginDone implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.DoneInfo Javadoc.

EventHandlerInfo Object

The com.bea.wlpi.common.plugin.EventHandlerInfo object maintains information about a plug-in event handler.

The EventHandlerInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new EventHandlerInfo object:

>     public EventHandlerInfo(
>       java.lang.String pluginName,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] classNames
>     )

The following table describes the EventHandlerInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-7 EventHandlerInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Localized name of the event handler. | name | public java.lang.String getName()
Localized description of the event handler. | description | public java.lang.String getDescription()
Array identifying the related plug-in class, including one entry (the fully-qualified Java class name) for the following KEY_* value. KEY_HANDLER: Key value specifying the com.bea.wlpi.server.plugin.EventHandler implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.EventHandlerInfo Javadoc.

EventInfo Object

The com.bea.wlpi.common.plugin.EventInfo object maintains information about a plug-in event handler.

The EventInfo class extends the following classes:

- com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object

- com.bea.wlpi.common.plugin.TemplateNodeInfo class, as defined in TemplateNodeInfo Object

You can use the following constructor to create a new EventInfo object:

>     public EventInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       java.lang.String[] classNames,
>       com.bea.wlpi.common.plugin.FieldInfo fieldInfo
>     )

The following table describes the EventHandlerInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-8 EventInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the event. | name | public java.lang.String getName()
Localized description of the event. | description | public java.lang.String getDescription()
Byte array representation of the graphical image (icon) for this plug-in, used by the Studio to represent this action when interface view is enabled. For more information about generating the byte array representation, see InfoObject Object. | iconByteArray | public javax.swing.Icon getIcon() public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginTriggerPanel implementation class name. KEY_EVENT: Key value specifying the com.bea.wlpi.server.plugin.PluginEvent implementation class name. | classNames | public java.lang.String getClassName(int key)
Plug-in field information. | fieldInfo | public com.bea.wlpi.common.plugin.FieldInfo getFieldInfo()

For more information, see the com.bea.wlpi.common.plugin.EventInfo Javadoc.

FieldInfo Object

The com.bea.wlpi.common.plugin.FieldInfo object maintains information about a plug-in field.

The FieldInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new FieldInfo object:

>     public FieldInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] classNames,
>       boolean supportsQualifiers
>     )

The following table describes the FieldInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-9 FieldInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the field. | name | public java.lang.String getName()
Localized description of the field. | description | public java.lang.String getDescription()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_FIELD: Key value specifying the com.bea.wlpi.common.plugin.PluginField implementation class name. DEFAULT_FIELD: Key value specifying the built-in field type that supports expression validation but not evaluation. This field type supports qualifiers and is used to validate expressions that reference plug-in data fields if the plug-in itself is not currently loaded. XMLFIELD: Key value specifying a built-in field type that returns XML single-element text values. This field type supports qualifiers (because XML is hierarchical). | classNames | public java.lang.String getClassName(int key)
Flag specifying whether or not the field type supports dot-delimited names. For example, if the PostalCode field is embedded in the Address field, the name for the field would be Address.PostalCode. The expression evaluator uses this flag to determine whether a field reference is valid in an expression in a plug-in Start, Event, or Event key. | supportsQualifiers | public boolean supportsQualifiers()

For more information, see the com.bea.wlpi.common.plugin.FieldInfo Javadoc.

FunctionInfo Object

The com.bea.wlpi.common.plugin.FunctionInfo object maintains information about a plug-in function.

The FieldInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new FunctionInfo object:

>     public FunctionInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String prototype,
>       java.lang.String[] classNames,
>       int argcmin,
>       int argcmax
>     )

The following table describes the FunctionInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-10 FunctionInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the function. | name | public java.lang.String getName()
Localized description of the function. | description | public java.lang.String getDescription()
Localized prototype for this function. | prototype | public java.lang.String prototype()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for the following KEY_* value. KEY_EVALUATOR: Key value specifying the com.bea.wlpi.common.plugin.PluginFunction implementation class name. | classNames | public java.lang.String getClassName(int key)
Minimum number of arguments permitted. The expression evaluator uses this information to validate calls to this function. | argcmin | public int getMinArgCount()
Maximum number of arguments permitted. The expression evaluator uses this information to validate calls to this function. | argcmax | public int getMaxArgCount()

For more information, see the com.bea.wlpi.common.plugin.FunctionInfo Javadoc.

HelpSetInfo Object

The com.bea.wlpi.common.plugin.HelpSetInfo object maintains information about the plug-in online help. Plug-ins can support both HTML and JavaHelp online help systems. The plug-in online help files must be packaged in a WAR file and deployed as part of the process engine. In order for the BPM client applications to retrieve the appropriate help files, the online help WAR file must be deployed under the name of the plug-in to which it correlates.

BPM client applications can use the Plug-in Manager (or other EJB) ClassLoader to determine the URL of the process engine. Using the HelpSetInfo object values, the client applications can obtain a full URL to access the help files through http or https.

The HelpSetInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new HelpSetInfo object:

>     public HelpSetInfo(
>       java.lang.String pluginName,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] helpNames,
>       int helpType
>     )

The following table describes the HelpSetInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-11 HelpSetInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version) supplying the online help set. In order for BPM client applications to form the correct URL for the help set, this name must match the web application under which the WAR file must be deployed. | pluginName | public java.lang.String getPluginName()
Localized name of the online help. This value is used as the label value for the user interface menu option that is used to access the non-context sensitive help. | name | public java.lang.String getName()
Localized description of the online help. | description | public java.lang.String getDescription()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_HELP_SET: Key value to retrieve the JavaHelp help set (.hs) filename or HTML help files root directory. KEY_HELP_ID: Key value to retrieve the JavaHelp help key or HTML filename for the main index page or table of contents. The value of each entry is interpreted according to the value of the helpType parameter, as defined in the table Help Types and Related Plug-In Classes. | helpNames | public java.lang.String getClassName(int key)
Type of help provided by the plug-in, which can be set to one of the following values: HELP_JAVA_HELP: Name of the JavaHelp help set, or help key for the main index page or table of contents. HELP_HTML: Name of the HTML help files root directory, or name of the main index page or table of contents, relative to the directory specified by the KEY_HELP_SET entry. The value of each entry is interpreted according to the value of the helpNames parameter, as defined in the table Help Types and Related Plug-In Classes. | helpType | public int getHelpType()

The following table defines the help types (helpType values) and related plug-in classes (helpNames values).

Table B-12 Help Types and Related Plug-In Classes

helpType Value | helpNames Value
--- | ---
KEY_HELP_SET | KEY_HELP_ID
HELP_JAVA_HELP | Name of the JavaHelp help set file, relative to the root of the WAR file, containing the help files (for example, javahelp/MyPluginHelpSet.hs). If an extension is not included, JavaHelp automatically appends an .hs extension. | JavaHelp help key for the main index page or table of contents.
HELP_HTML | Name of the root directory of the HTML help files that must include a trailing slash (for example, htmlhelp/). | Name of the HTML file (not including the required .htm extension) containing the main index page or table of contents, relative to the directory specified by the KEY_HELP_SET entry.

For more information, see the com.bea.wlpi.common.plugin.HelpSetInfo Javadoc.

InfoObject Object

The com.bea.wlpi.common.plugin.InfoObject object provides the abstract base class for all plug-in value objects.

You can use the following constructor to create a new InfoObject object:

>     public InfoObject(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] classNames
>     )

The following table describes the InfoObject object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-13 InfoObject Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the object. | name | public java.lang.String getName()
Localized description of the object. | description | public java.lang.String getDescription()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the KEY_* values provided by the subclass. | classNames | public java.lang.String getClassName(int key)

The InfoObject object also provides the following method for generating an iconByteArray value from an input stream that can be used when constructing ActionInfo, DoneInfo, EventInfo, StartInfo, and TemplateDefinitionPropertiesInfo objects:

>     public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

For more information, see the com.bea.wlpi.common.plugin.InfoObject Javadoc.

PluginCapabilitiesInfo Object

The com.bea.wlpi.common.plugin.PluginCapabilitiesInfo object maintains information about the plug-in capabilities.

The PluginCapabilitiesInfo object describes the complete set of plug-in capabilities once the plug-in has been loaded. Prior to being loaded, basic plug-in information can be accessed using the com.bea.wlpi.common.plugin.PluginInfo object, as described in PlugInfo Object.

You can use the following constructor to create a new PluginCapabilitiesInfo object:

>     public PluginCapabilitiesInfo(
>       com.bea.wlpi.common.plugin.PluginInfo info,
>       com.bea.wlpi.common.plugin.ActionCategoryInfo[] actions,
>       com.bea.wlpi.common.plugin.EventInfo[] events,
>       com.bea.wlpi.common.plugin.FieldInfo[] fields,
>       com.bea.wlpi.common.plugin.FunctionInfo[] functions,
>       com.bea.wlpi.common.plugin.StartInfo[] starts,
>       com.bea.wlpi.common.plugin.DoneInfo[] dones,
>       com.bea.wlpi.common.plugin.VariableTypeInfo[] variableTypes,
>       com.bea.wlpi.common.plugin.TemplatePropertiesInfo[] template,
>       com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo[]
>         templateDefinition,
>       com.bea.wlpi.common.plugin.EventHandlerInfo eventHandler
>     )

The following table describes the PluginCapabilitiesInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-14 PluginCapabilitiesInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Basic plug-in information. | info | public java.lang.String getPluginInfo()
Actions and action categories provided by the plug-in. | actions | public com.bea.wlpi.common.plugin.ActionCategoryInfo[] getActionInfo()
Events provided by the plug-in. | events | public com.bea.wlpi.common.plugin.EventInfo[] getEventInfo()
Fields provided by the plug-in. | fields | public com.bea.wlpi.common.plugin.FieldInfo[] getFieldInfo()
Functions provided by the plug-in. | functions | public com.bea.wlpi.common.plugin.FunctionInfo[] getFunctionInfo()
Start nodes provided by the plug-in. | starts | public com.bea.wlpi.common.plugin.StartInfo[] getStartInfo()
Done nodes provided by the plug-in. | dones | public com.bea.wlpi.common.plugin.DoneInfo[] getDoneInfo()
Variables provided by the plug-in. | variableTypes | public com.bea.wlpi.common.plugin.VariableTypesInfo[] getVariableTypesInfo()
Workflow template properties provided by the plug-in. | template | public com.bea.wlpi.common.plugin.TemplatePropertiesInfo[] getTemplateInfo()
Workflow template definition properties provided by the plug-in. | templateDefinition | public com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo[] getTemplateDefinitionInfo()
Event handler information. | eventHandler | public com.bea.wlpi.common.plugin.EventHandlerInfo getEventHandlerInfo()

For more information, see the com.bea.wlpi.common.plugin.PluginCapabilitiesInfo Javadoc.

PluginDependency Object

The com.bea.wlpi.common.plugin.PluginDependency object maintains information about the plug-in dependencies.

The PluginDependency class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new PluginCapabilitiesInfo object:

>     public PluginDependency(
>       java.lang.String pluginName,
>       java.lang.String description,
>       java.lang.String masterPluginName,
>       java.lang.String vendor,
>       com.bea.wlpi.common.VersionInfo version
>     )

The following table describes the PluginDependency object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-15 PluginDependency Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Localized description of the object. | description | public java.lang.String getDescription()
Master plug-in name (reverse-DNS version). | masterPluginName | public java.lang.String getMasterPluginName()
Master plug-in vendor name. | vendor | public java.lang.String getVendor()
Master plug-in version. | version | public com.bea.wlpi.common.VersionInfo getVersion()

For more information, see the com.bea.wlpi.common.plugin.PluginDependency Javadoc.

PlugInfo Object

The com.bea.wlpi.common.plugin.PluginInfo object maintains basic information about the plug-in.

The PluginInfo object describes the basic set of plug-in capabilities before the plug-in has been loaded. After being loaded, basic plug-in information can be accessed using the com.bea.wlpi.common.plugin.PluginCapabilitiesInfo object, as described in PluginCapabilitiesInfo Object.

The PluginInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new PluginCapabilitiesInfo object:

>     public PluginInfo(
>       java.lang.String pluginName,
>       java.lang.String name,
>       java.util.Locale lc,
>       java.lang.String vendor,
>       java.lang.String url,
>       com.bea.wlpi.common.VersionInfo version,
>       com.bea.wlpi.common.VersionInfo pluginFrameworkVersion,
>       com.bea.wlpi.common.plugin.PluginDependency[] dependencies,
>       com.bea.wlpi.common.plugin.ConfigurationInfo config,
>       com.bea.wlpi.common.plugin.HelpSetInfo helpSet
>     )

The following table describes the PluginDependency object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-16 PluginInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Localized name of the object. | name | public java.lang.String getName()
Locale to localize the display strings. | lc | public java.lang.String getLocale()
Plug-in vendor name. | vendor | public java.lang.String getVendor()
Plug-in vendor URL. | url | public java.lang.String getURL()
Plug-in version. | version | public com.bea.wlpi.common.VersionInfo getVersion()
Plug-in framework version. | pluginFrameworkVersion | public com.bea.wlpi.common.VersionInfo getPluginFrameworkVersion()
Plug-in dependencies. | dependencies | public com.bea.wlpi.common.plugin.PluginDependency[] getDependencyInfo()
Plug-in configuration information. | config | public com.bea.wlpi.common.plugin.ConfigurationInfo getConfigurationInfo()
JavaHelp help set provided by plug-in. | helpSet | public com.bea.wlpi.common.plugin.HelpSetInfo getHelpSetInfo()

For more information, see the com.bea.wlpi.common.plugin.PluginInfo Javadoc.

StartInfo Object

The com.bea.wlpi.common.plugin.StartInfo object maintains information about a plug-in Start node.

The StartInfo class extends the following classes:

- com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object

- com.bea.wlpi.common.plugin.TemplateNodeInfo class, as defined in TemplateNodeInfo Object

You can use the following constructor to create a new StartInfo object:

>     public StartInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       java.lang.String[] classNames,
>       com.bea.wlpi.common.plugin.FieldInfo fieldInfo
>     )

The following table describes the ConfigurationInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-17 StartInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the Start node. | name | public java.lang.String getName()
Localized description of the Start node. | description | public java.lang.String getDescription()
Byte array representation of the graphical image (icon) for this plug-in, used by the Studio to represent this action when interface view is enabled. For more information about generating the byte array representation, see InfoObject Object. | iconByteArray | public javax.swing.Icon getIcon() public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. KEY_START: Key value specifying the com.bea.wlpi.server.plugin.PluginStart2 implementation class name. | classNames | public java.lang.String getClassName(int key)
Plug-in field information. | fieldInfo | public com.bea.wlpi.common.plugin.FieldInfo getFieldInfo()

For more information, see the com.bea.wlpi.common.plugin.StartInfo Javadoc.

TemplateDefinitionPropertiesInfo Object

The com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo object maintains information about the plug-in template definition properties.

The TemplateDefinitionPropertiesInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new TemplateDefinitionPropertiesInfo object:

>     public DoneInfo(
>       java.lang.String pluginName,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] classNames
>     )

The following table describes the TemplateDefinitionPropertiesInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-18 TemplateDefinitionPropertiesInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Localized name of the object. This string defines the contents of the plug-in tab in the Template Definition Properties dialog box. | name | public java.lang.String getName()
Localized description of the object. | description | public java.lang.String getDescription()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo Javadoc.

TemplateNodeInfo Object

The com.bea.wlpi.common.plugin.TemplateNodeInfo object maintains information about a plug-in template definition node.

TemplateNodeInfo is extended by the following classes:

- com.bea.wlpi.common.plugin.DoneInfo

- com.bea.wlpi.common.plugin.EventInfo

- com.bea.wlpi.common.plugin.StartInfo

The TemplateNodeInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new TemplateNodeInfo object:

>     public TemplateNodeInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       byte[] iconByteArray,
>       java.lang.String[] classNames
>     )

The following table describes the TemplateDefinitionPropertiesInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-19 TemplateDefinitionPropertiesInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the template definition node. | name | public java.lang.String getName()
Localized description of the template definition node. | description | public java.lang.String getDescription()
Byte array representation of the graphical image (icon) for this plug-in, used by the Studio to represent this action when interface view is enabled. For more information about generating the byte array representation, see InfoObject Object. | iconByteArray | public javax.swing.Icon getIcon() public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the KEY_* values defined for the corresponding subclasses. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.TemplateNodeInfo Javadoc.

TemplatePropertiesInfo Object

The com.bea.wlpi.common.plugin.TemplatePropertiesInfo object maintains information about the plug-in template properties.

The TemplatePropertiesInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new TemplatePropertiesInfo object:

>     public TemplatePropertiesInfo(
>       java.lang.String pluginName,
>       java.lang.String name,
>       java.lang.String description,
>       java.lang.String[] classNames
>     )

The following table describes the TemplateDefinitionPropertiesInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-20 TemplatePropertiesInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Localized name of the object. This string defines the contents of the plug-in tab in the Template Properties dialog box. | name | public java.lang.String getName()
Localized description of the object. | description | public java.lang.String getDescription()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_DATA: Key value specifying the com.bea.wlpi.common.plugin.PluginData implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.TemplatePropertiesInfo Javadoc.

VariableTypeInfo Object

The com.bea.wlpi.common.plugin.VariableTypeInfo object maintains information about a plug-in variable.

The VariableTypeInfo class extends the com.bea.wlpi.common.plugin.InfoObject class, as described in InfoObject Object.

You can use the following constructor to create a new VariableTypeInfo object:

>     public VariableTypeInfo(
>       java.lang.String pluginName,
>       int ID,
>       java.lang.String name,
>       java.lang.String description,
>       int variableType,
>       java.lang.Class valueClass,
>       java.lang.String[] classNames
>     )

The following table describes the VariableTypeInfo object information, the constructor parameters used to define the data, and the methods that can be used to access that information after the object is defined, if applicable.

Table B-21 VariableTypeInfo Object Information

Object Information | Constructor Parameter | Get Method
--- | --- | ---
Plug-in name (reverse-DNS version). | pluginName | public java.lang.String getPluginName()
Plug-in ID. | ID | public int getID()
Localized name of the variable type. | name | public java.lang.String getName()
Localized description of the variable type. | description | public java.lang.String getDescription()
Variable type which can be set to one of the following integer values: TYPE_ENTITY: Remote reference to an entity EJB. TYPE_OBJECT: Local Java object. TYPE_SESSION: Remove reference to a session EJB. | variableType | public int getVariableType()
Fully-qualified Java class of the allowed value type. | valueClass | public java.lang.Class getValueClass()
Array identifying related plug-in classes, including one entry (the fully-qualified Java class name) for each of the following KEY_* values: KEY_RENDERER: Key value specifying the com.bea.wlpi.common.plugin.PluginVariableRenderer implementation class name. KEY_PANEL: Key value specifying the com.bea.wlpi.common.plugin.PluginPanel implementation class name. | classNames | public java.lang.String getClassName(int key)

For more information, see the com.bea.wlpi.common.plugin.VariableTypeInfo Javadoc.