Plug-In Value Object Summary

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)

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)

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)

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()

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)

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)

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)

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()

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()

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()

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()

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

helpType Value	helpNames Value
helpType 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.

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)

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()

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()

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()

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.PluginStart implementation class name.	classNames	public java.lang.String getClassName(int key)
Plug-in field information.	fieldInfo	public com.bea.wlpi.common.plugin.FieldInfo getFieldInfo()

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)

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)

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)

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)


	BEA Home \| Events \| Solutions \| Partners \| Products \| Services \| Download \| Developer Center \| WebSUPPORT
	http://www.oracle.com/technology/documentation/index.html \| Site Map \| Search \| PDF Files \| Contact \| Glossary

WLI Doc Home \| BPM Topics \| Programming BPM Plug-Ins \| Previous Topic \| Next Topic \| Contents \| Index \| View as PDF