com.bankframe.fe.statemachine.ext.apps
Class Inputs

java.lang.Object
  com.bankframe.fe.statemachine.ext.apps.Inputs

public class Inputs
extends Object

Nested Class Summary

static class

Inputs.InputSourceDescriptor

Field Summary

static String	FAILED_VALIDATION_ERRORS
static int	INPUT_SOURCE_ANY
static Inputs.InputSourceDescriptor	INPUT_SOURCE_DESCRIPTOR_ANY
static Inputs.InputSourceDescriptor	INPUT_SOURCE_DESCRIPTOR_REQUEST
static Inputs.InputSourceDescriptor	INPUT_SOURCE_DESCRIPTOR_USER_SESSION
static Inputs.InputSourceDescriptor	INPUT_SOURCE_DESCRIPTOR_VISIT
static int	INPUT_SOURCE_REQUEST
static int	INPUT_SOURCE_USER_SESSION
static int	INPUT_SOURCE_VISIT
static Inputs.InputSourceDescriptor[]	inputSourceDescriptors

Constructor Summary

Inputs(IRequest request, IUserSession userSession, ResponseData responseData)
Constructor for Inputs.

Method Summary

Object	getParameter(String parameterName) This method returns an Object contained in one of the input sources against the given name, or null if no object is found.
Object	getParameter(String parameterName, int inputSource) This method returns the Object in the given inputSource with the given name, or null.
Enumeration	getParameterNames() This method returns a collected view of all the parameter names known accross all three input sources.
IRequest	getRequest() Returns the request.
ResponseData	getResponseData() Returns the responseData.
IUserSession	getUserSession() Returns the userSession.
void	setParameter(String parameterName, Object parameterValue) This method adds the given name and value to INPUT_SOURCE_REQUEST.
void	setParameter(String parameterName, Object parameterValue, int inputSource) This method adds the given name and value to the given inputSource.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_SOURCE_ANY

public static final int INPUT_SOURCE_ANY

See Also:

Constant Field Values

INPUT_SOURCE_REQUEST

public static final int INPUT_SOURCE_REQUEST

See Also:

Constant Field Values

INPUT_SOURCE_VISIT

public static final int INPUT_SOURCE_VISIT

See Also:

Constant Field Values

INPUT_SOURCE_USER_SESSION

public static final int INPUT_SOURCE_USER_SESSION

See Also:

Constant Field Values

INPUT_SOURCE_DESCRIPTOR_ANY

public static final Inputs.InputSourceDescriptor INPUT_SOURCE_DESCRIPTOR_ANY

INPUT_SOURCE_DESCRIPTOR_REQUEST

public static final Inputs.InputSourceDescriptor INPUT_SOURCE_DESCRIPTOR_REQUEST

INPUT_SOURCE_DESCRIPTOR_USER_SESSION

public static final Inputs.InputSourceDescriptor INPUT_SOURCE_DESCRIPTOR_USER_SESSION

INPUT_SOURCE_DESCRIPTOR_VISIT

public static final Inputs.InputSourceDescriptor INPUT_SOURCE_DESCRIPTOR_VISIT

inputSourceDescriptors

public static final Inputs.InputSourceDescriptor[] inputSourceDescriptors

FAILED_VALIDATION_ERRORS

public static final String FAILED_VALIDATION_ERRORS

See Also:

Constant Field Values

Constructor Detail

Inputs

public Inputs(IRequest request,
              IUserSession userSession,
              ResponseData responseData)

Constructor for Inputs.

Parameters:

request - The IRequest object, corresponding to INPUT_SOURCE_REQUEST.

userSession - The IUserSession object, corresponding to INPUT_SOURCE_USER_SESSION.

responseData - The ResponseData object, corresponding to INPUT_SOURCE_VISIT.

Method Detail

getRequest

public IRequest getRequest()

Returns the request.

Returns:

IRequest

getResponseData

public ResponseData getResponseData()

Returns the responseData.

Returns:

ResponseData

getUserSession

public IUserSession getUserSession()

Returns the userSession.

Returns:

IUserSession

getParameterNames

public Enumeration getParameterNames()

This method returns a collected view of all the parameter names known accross all three input sources.

The parameter names are ordered with INPUT_SOURCE_REQUEST names first, then INPUT_SOURCE_VISIT names, and finally INPUT_SOURCE_USER_SESSION names.

Returns:

Enumeration

getParameter

public Object getParameter(String parameterName)

This method returns an Object contained in one of the input sources against the given name, or null if no object is found.

The input sources are searched in the order INPUT_SOURCE_REQUEST, then INPUT_SOURCE_VISIT, finally INPUT_SOURCE_USER_SESSION.

Parameters:

parameterName -

Returns:

Object

getParameter

public Object getParameter(String parameterName,
                           int inputSource)

This method returns the Object in the given inputSource with the given name, or null.

Parameters:

parameterName -

inputSource -

Returns:

Object

Throws:

IllegalArgumentException - if inputSource is not one of INPUT_SOURCE_REQUEST, INPUT_SOURCE_VISIT, INPUT_SOURCE_USER_SESSION.

setParameter

public void setParameter(String parameterName,
                         Object parameterValue)

This method adds the given name and value to INPUT_SOURCE_REQUEST.

Parameters:

parameterName -

parameterValue -

setParameter

public void setParameter(String parameterName,
                         Object parameterValue,
                         int inputSource)

This method adds the given name and value to the given inputSource.

Parameters:

parameterName -

parameterValue -

inputSource -

Throws:

IllegalArgumentException - if inputSource is not one of INPUT_SOURCE_REQUEST, INPUT_SOURCE_VISIT, INPUT_SOURCE_USER_SESSION.