com.bea.wlpi.common.plugin
Class FunctionInfo
java.lang.Object
|
+--com.bea.wlpi.common.plugin.InfoObject
|
+--com.bea.wlpi.common.plugin.FunctionInfo
- All Implemented Interfaces:
- java.lang.Comparable, PluginConstants, java.io.Serializable
- public final class FunctionInfo
- extends InfoObject
Provides information about an evaluator function defined by a plugin.
- Since:
- WebLogic Process Integrator 2.0
- See Also:
PluginFunction
, 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 |
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)
Create a new FunctionInfo . |
Method Summary |
int |
getMaxArgCount()
Return the maximum number of arguments permitted. |
int |
getMinArgCount()
Return the minimum number of arguments permitted. |
java.lang.String |
getPrototype()
Return the prototype of this function. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
KEY_EVALUATOR
public static final int KEY_EVALUATOR
- Key value to retrieve the
PluginFunction
implementation
class name.
FunctionInfo
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)
- Create a new
FunctionInfo
.
- Parameters:
pluginName
- The reverse-DNS name of the plugin supplying this
function.ID
- The unique plugin-supplied identifier for this function.name
- The non-localized name of the function represented
by this function.description
- The localized description of this function.prototype
- The localized prototype for this function, as pasted by
the WebLogic Process Integrator Expression Editor. The function name in
this prototype has to match the name
parameter.classNames
- A single-element array to identify plugin-supplied
classes related to this function. The array contains one entry for
each of the KEY_*
values listed above. The value for each
entry is the corresponding fully qualified Java class name.argcmin
- Minimum number of arguments permitted. The expression
evaluator uses this information to validate calls to this function.argcmax
- Maximum number of arguments permitted. The expression
evaluator uses this information to validate calls to this function.
getPrototype
public java.lang.String getPrototype()
- Return the prototype of this function.
- Returns:
- The function prototype.
getMinArgCount
public int getMinArgCount()
- Return the minimum number of arguments permitted.
- Returns:
- Minimum argument count.
getMaxArgCount
public int getMaxArgCount()
- Return the maximum number of arguments permitted.
- Returns:
- Maximum argument count.
BEA WebLogic Process Integrator is a trademark of BEA Systems, Inc.
Copyright (c) 2001 BEA Systems, Inc.
All rights reserved.