com.bea.wlpi.common.plugin
Class CategoryInfo
java.lang.Object
|
+--com.bea.wlpi.common.plugin.InfoObject
|
+--com.bea.wlpi.common.plugin.ActionCategoryInfo
|
+--com.bea.wlpi.common.plugin.CategoryInfo
- All Implemented Interfaces:
- java.lang.Comparable, PluginConstants, java.io.Serializable
- public final class CategoryInfo
- extends ActionCategoryInfo
Provides information about an action category defined by a plugin.
- Since:
- WebLogic Process Integrator 2.0
- See Also:
- Serialized Form
Fields inherited from interface com.bea.wlpi.common.plugin.PluginConstants |
CATEGORY_ID_BEGIN, CATEGORY_ID_EXCEPTION, CATEGORY_ID_INTEGRATION, CATEGORY_ID_MISCELLANEOUS, CATEGORY_ID_NEW, CATEGORY_ID_TASK, CATEGORY_ID_WORKFLOW, DEFINITION_CREATED, DEFINITION_DELETED, DEFINITION_UPDATED, EVENT_NOTIFICATION_ALL, EVENT_NOTIFICATION_NONE, HELP_HTML, HELP_JAVA_HELP, INSTANCE_ABORTED, INSTANCE_COMPLETED, INSTANCE_CREATED, INSTANCE_DELETED, INSTANCE_UPDATED, MODE_AUTOMATIC, MODE_DISABLED, MODE_MANUAL, NOTIFICATION_DEFINITION, NOTIFICATION_INSTANCE, NOTIFICATION_TASK, NOTIFICATION_TEMPLATE, STATUS_DEPLOYED, STATUS_ERROR, STATUS_INITIALIZED, STATUS_LOADED, STATUS_LOADING, STATUS_MISSING, STATUS_UNLOADING, TASK_ASSIGNED, TASK_COMPLETED,
|
Constructor Summary |
CategoryInfo(java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
int parentSystemID,
ActionCategoryInfo[] subNodes)
Create a new action category. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
CategoryInfo
public CategoryInfo(java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
int parentSystemID,
ActionCategoryInfo[] subNodes)
- Create a new action category.
- Parameters:
pluginName
- The reverse-DNS name of the plugin supplying this
action category.ID
- The plugin-assigned unique identifier for this action
category.name
- The localized name of this action category.description
- The localized description of this action category.parentSystemID
- The system ID of this object's parent category.subnodes
- A list of actions or categories belonging to this
category.
addSubNode
public void addSubNode(ActionCategoryInfo node)
- Add an action or sub-category to this category. Called by the Plugin
Manager when merging plugin-provided actions and categories into one
tree. Plugins should define their subnodes by passing them to the
constructor, rather than by calling this method.
- Parameters:
node
- The action or sub-category to add.
findCategory
public CategoryInfo findCategory(int systemID)
- Find a category by systemID. The method recursively searches this
category and its sub-categories to locate the category with a matching
systemID. Called by the Plugin Manager when merging plugin-provided
actions and categories into one tree.
- Parameters:
systemID
- The systemID of the category to find.- Returns:
- The matching category, or
null
if not found.
getSubnodes
public ActionCategoryInfo[] getSubnodes()
- Return a list of the action nodes belonging to this category.
- Returns:
- A list of actions and categories.
getSystemID
public int getSystemID()
- Return the unique system ID assigned by the Plugin Manager.
- Returns:
- The unique system ID assigned by the Plugin Manager.
setSystemID
public int setSystemID(int systemID)
- Set the category's system ID. The method sets the systemID for this
category and the parentSystemID for its subnodes. It then recurses
through any sub-categories, assigning a new systemID to each. Called by
the Plugin Manager to assign a unique category ID to each category in a
plugin-defined action category tree: clients must not call this method.
- Parameters:
systemID
- The starting system ID, assigned by the Plugin Manager.- Returns:
- The last systemID assigned within the method.
- Throws:
java.lang.IllegalStateException
- if this method is called more than once.
BEA WebLogic Process Integrator is a trademark of BEA Systems, Inc.
Copyright (c) 2001 BEA Systems, Inc.
All rights reserved.