Package com.avoka.tm.func

Class FuncParam

java.lang.Object

com.avoka.tm.func.FuncParam

public class FuncParam
extends Object

Provides a Fluent function parameter class.

Since:

17.10.0

Field Summary

Fields

Modifier and Type	Field	Description
final Document	appDoc	The mutable XML application document.
final Map<String,Object>	params	The request parameters.
final HttpServletRequest	request	The HTTP request.
final SvcDef	svcDef	The service definition VO.
final String	trigger	The function trigger.
static final String	TRIGGER_BACKGROUND_DELIVERY	The 'Background Delivery' function trigger.
static final String	TRIGGER_FORM_FUNCTION	The 'Form Function' function trigger.
static final String	TRIGGER_FORM_INELIGIBLE	The 'Form Ineligible' function trigger.
static final String	TRIGGER_FORM_OPEN	The 'Form Open' function trigger.
static final String	TRIGGER_FORM_RESUME	The 'Form Resume' function trigger.
static final String	TRIGGER_FORM_UPDATE	The 'Form Update' function trigger.
static final String	TRIGGER_USER_CANCEL	The 'User Cancel' function trigger.
static final String	TRIGGER_USER_SAVE	The 'User Save' function trigger.
static final String	TRIGGER_USER_SUBMIT	The 'User Submit' function trigger.
final Txn	txn	The transaction VO.
final User	user	The user VO.

Constructor Summary

Constructors

Constructor	Description
FuncParam(String trigger, Document appDoc, Map<String,Object> params, HttpServletRequest request, SvcDef svcDef, Txn txn, User user)	Create a FuncParam value object with the given attributes.

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TRIGGER_FORM_OPEN

public static final String TRIGGER_FORM_OPEN

The 'Form Open' function trigger.

See Also:

• Constant Field Values

TRIGGER_FORM_RESUME

public static final String TRIGGER_FORM_RESUME

The 'Form Resume' function trigger.

See Also:

• Constant Field Values

TRIGGER_FORM_UPDATE

public static final String TRIGGER_FORM_UPDATE

The 'Form Update' function trigger.

See Also:

• Constant Field Values

TRIGGER_FORM_INELIGIBLE

public static final String TRIGGER_FORM_INELIGIBLE

The 'Form Ineligible' function trigger.

See Also:

• Constant Field Values

TRIGGER_FORM_FUNCTION

public static final String TRIGGER_FORM_FUNCTION

The 'Form Function' function trigger.

See Also:

• Constant Field Values

TRIGGER_USER_SAVE

public static final String TRIGGER_USER_SAVE

The 'User Save' function trigger.

See Also:

• Constant Field Values

TRIGGER_USER_SUBMIT

public static final String TRIGGER_USER_SUBMIT

The 'User Submit' function trigger.

See Also:

• Constant Field Values

TRIGGER_USER_CANCEL

public static final String TRIGGER_USER_CANCEL

The 'User Cancel' function trigger.

See Also:

• Constant Field Values

TRIGGER_BACKGROUND_DELIVERY

public static final String TRIGGER_BACKGROUND_DELIVERY

The 'Background Delivery' function trigger.

See Also:

• Constant Field Values

trigger

public final String trigger

The function trigger.

appDoc

public final Document appDoc

The mutable XML application document.

params

public final Map<String,Object> params

The request parameters.

request

public final HttpServletRequest request

The HTTP request.

svcDef

public final SvcDef svcDef

The service definition VO.

txn

public final Txn txn

The transaction VO.

user

public final User user

The user VO.

Constructor Details

FuncParam

public FuncParam(String trigger,
 Document appDoc,
 Map<String,Object> params,
 HttpServletRequest request,
 SvcDef svcDef,
 Txn txn,
 User user)

Create a FuncParam value object with the given attributes.

Parameters:

trigger - the function trigger

appDoc - the application XML Document

params - the request parameters

request - the servlet request

svcDef - the service definition

txn - the transaction value object

user - the user value object

Method Details

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of the object.