com.ibm.pim.system
Interface PIMScript


public interface PIMScript

Interface for the PIMScript object.

Since:
6.0.0

Nested Class Summary
static class PIMScript.ScriptContext
          Script globals pre-defined values
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String launch(java.util.HashMap<java.lang.String,java.lang.Object> scriptGlobals)
          Executes the script.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

launch

java.lang.String launch(java.util.HashMap<java.lang.String,java.lang.Object> scriptGlobals)
Executes the script.

Note, you can pass in a map containing ScriptContext.OUT --> new PrinterWriter(System.out) and ScriptContext.ERR --> new PrinterWriter(System.err) if you want output to go to standard out and standard error. Otherwise, output is captured and returned).

Parameters:
scriptGlobals - A HashMap which contains argument name as key and argument value as value. Null may be passed if there are no script parameters. Pre-defined values are defined in ScriptContext
Returns:
String script output containing both standard output and standard error.
Throws:
PIMInternalException - If an internal exception occurs.
PIMAuthorizationException - Reserved for future use