com.unica.publicapi.plan.plugin.procedure
Interface IProcedure

All Superinterfaces:
IPlugin
All Known Subinterfaces:
ITriggerProcedure

public interface IProcedure
extends IPlugin


Field Summary
static java.lang.String PLAN_INTEGRATIONWS_URL_PARAMNAME
          Standard name for URL to Plan's Integration Webservice.
static java.lang.String PLAN_PROCEDUREKEY_PARAMNAME
          Standard name for a Plan procedure key parameter.
 
Method Summary
 ProcedureResult execute(IExecutionContext context, java.util.Map parameters)
          Procedure's execute method.
 
Methods inherited from interface com.unica.publicapi.plan.plugin.IPlugin
destroy, getDescription, getDisplayName, getName, getVersion, initialize
 

Field Detail

PLAN_INTEGRATIONWS_URL_PARAMNAME

static final java.lang.String PLAN_INTEGRATIONWS_URL_PARAMNAME
Standard name for URL to Plan's Integration Webservice. Wrap this in a StringNameValue object when used with AffiniumScheduler; value should be the string form of the URL, e.g.,

See Also:
Constant Field Values

PLAN_PROCEDUREKEY_PARAMNAME

static final java.lang.String PLAN_PROCEDUREKEY_PARAMNAME
Standard name for a Plan procedure key parameter. Wrap this in a StringNameValue object when used with AffiniumScheduler; value should be the key from your procedure, e.g., "FoobarCreateOfferProcedure".

See Also:
Constant Field Values
Method Detail

execute

ProcedureResult execute(IExecutionContext context,
                        java.util.Map parameters)
                        throws ProcedureExecutionException
Procedure's execute method.

If called from a webservice, it's the caller's responsibility to convert NameValue parameters to their non-sequence map form, i.e.,

 StringNameValue("foo", 1, "value1"),
 StringNameValue("foo", 2, "value2")
 ==>
 one map entry:
 entry.key = "foo" 
 entry.value = String[]{"value1", "value2"} 
 

This work is done automatically by the ProcedureManager.

Parameters:
context - caller's execution context
parameters - a map of procedure parameters.
Returns:
result of procedure execution
Throws:
ProcedureExecutionException