public interface PatternInstanceManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Modifier and Type | Method and Description |
---|---|
void |
addProjectToPatternInstance(java.lang.String projectName)
Adds the project to the working set for this pattern instance.
|
MessageFlow |
getMessageFlow(java.lang.String projectName,
java.lang.String relativePath)
Gets a message flow after any target properties have been changed.
|
java.lang.String[] |
getParameterList() |
PatternParameterTable |
getParameterTable(java.lang.String parameterId) |
java.lang.String |
getParameterValue(java.lang.String parameterId)
Gets the string value of a parameter in this pattern instance.
|
java.lang.String |
getPatternInstanceName() |
java.lang.Class<?> |
getPluginClass(java.lang.String pluginId,
java.lang.String className)
Looks up the class that matches this plug-in and class name.
|
java.lang.Object |
getUserDefinedValue(java.lang.String name) |
java.lang.String |
getWorkspaceLocation() |
boolean |
isParameterTable(java.lang.String parameterId) |
void |
removeMessageFlow(MessageFlow messageFlow)
Removes a message flow from the
PatternInstanceManager
The message flow will not be saved to any pattern instance project. |
void |
runScript(java.lang.String pluginId,
java.lang.String relativePath)
Runs the PHP script associated with this relative path.
|
boolean |
setParameterValue(java.lang.String parameterId,
java.lang.String parameterValue)
Sets the string value of a parameter in this pattern instance.
|
void |
setUserDefinedValue(java.lang.String name,
java.lang.Object value)
Stores a user-defined value in the pattern instance.
|
static final java.lang.String copyright
java.lang.Class<?> getPluginClass(java.lang.String pluginId, java.lang.String className) throws java.lang.ClassNotFoundException
pluginId
- The plug-in symbolic name.className
- The Java class name to find.Class
instance.java.lang.ClassNotFoundException
- ClassNotFoundException
.java.lang.String getParameterValue(java.lang.String parameterId)
parameterId
- The unique identifier of a parameter.null
.java.lang.String[] getParameterList()
boolean setParameterValue(java.lang.String parameterId, java.lang.String parameterValue)
parameterId
- The unique identifier of a parameter.parameterValue
- The value for the parameter.true
if the parameter was successfully set.void runScript(java.lang.String pluginId, java.lang.String relativePath)
pluginId
identifies the plug-in containing the PHP script.
The relativePath
is the path to the PHP script in the
plug-in - it should not have any leading directory separator character.
The output from the PHP script is ignored. You can write the output from
PHP templates to files in pattern instance projects by calling
mb_pattern_run_template
from within the PHP script.pluginId
- The plug-in that contains the script.relativePath
- The relative path to the script.java.lang.String getPatternInstanceName()
java.lang.String getWorkspaceLocation()
MessageFlow getMessageFlow(java.lang.String projectName, java.lang.String relativePath)
projectName
- The project name excluding pattern instance prefix.relativePath
- The relative path to the message flow in the project.MessageFlow
or null
.void removeMessageFlow(MessageFlow messageFlow)
PatternInstanceManager
The message flow will not be saved to any pattern instance project.messageFlow
- The message flow to remove from the pattern instance.PatternParameterTable getParameterTable(java.lang.String parameterId)
PatternParameterTable
containing the table for a parameter.boolean isParameterTable(java.lang.String parameterId)
true
if this is parameter is a table of values.void setUserDefinedValue(java.lang.String name, java.lang.Object value)
name
- The unique key for the value.value
- The actual value to be stored.java.lang.Object getUserDefinedValue(java.lang.String name)
null
.void addProjectToPatternInstance(java.lang.String projectName) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- IllegalArgumentException
.