IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.cs.html
Interface JspContextServices

All Known Implementing Classes:
DSEJspContextServices

public interface JspContextServices

Interface that defines the protocol to access the context from a JSP


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addDataElementToTransitionContext(java.lang.String transitionName, java.lang.String dataName)
          Add a data element in the the transition context for the specified transition
 void createTransitionContext(java.lang.String transitionName, Vector dataNames)
          Create a transiton context for the specified transition with the set of dataNames
 java.lang.String getBaseWebPath()
          Obtain the relative path (relative to the web app server web path) for jsp resources.
 Context getContext()
          Get the operation context for the page which initialized this bean.
 java.lang.String[] getCrossValidationErrorList()
          Return the current list of cross validation errors.
 DataElement getElement(java.lang.String name)
          Returns the named data element from the context.
 ErrorInfo getErrorInfo(java.lang.String name)
          Returns the error info object associated to the named field in the context.
 java.lang.String getErrorPageHtml(java.lang.String name)
          Return the error page name
 DSEException getException()
          If the toolkit placed an exception in the HttpServletRequest with key name dseexception, then it can be saved here when the bean is initialized.
 java.lang.String getExceptionMessage()
          Return message text cooresponding to the current exception.
 java.lang.String getFieldErrorMarker(java.lang.String name)
          Return the current error marker only if the given field is in error.
 java.lang.String getFieldLabel(java.lang.String name)
          Returns the label associated with the given field in the context.
 java.lang.String getFieldValidationError(java.lang.String name, int idx)
          Return the field error message text at the specified index.
 java.lang.String getFieldValidationErrorDecorated(java.lang.String name, int idx)
          Return the field error message text at the specified index decorated with prefix and suffix HTML strings.
 java.lang.String[] getFieldValidationErrorList(java.lang.String name)
          Retrieve the entire error list for the field.
 java.lang.String getInputDataInError(java.lang.String name)
          Returns the value of the wrong data typed by the user.
 java.lang.String[] getJspFormatErrorList()
          Returns the list of Jsp Format Errors that were found during Jsp Processing.
 java.lang.String getLinkToPage(java.lang.String webPath, java.lang.String pageName, java.lang.String linkText)
          Emit the Html to the JspWriter stream to create a link with given text to a given JSP saved in a given web path (relative to the base JSP path for the application server).
 java.lang.String getLocaleId()
          Obtain any extra path information passed on the call to establish the session.
 java.lang.String getRequiredHtmlFields()
          Returns an string containing the HTML for all of the HTML Client required fields.
 java.lang.String getRequiredHtmlFields(java.lang.String parentctx, java.lang.String opname)
          Returns an string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information.
 java.lang.String getRequiredHtmlFieldsForGETMethod()
          Returns a string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information.
 java.lang.String getRequiredHtmlFieldsForGETMethod(java.lang.String parentctx, java.lang.String opname)
          Returns an string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information.
 java.lang.String getSessionId()
          Returns the current session identifier string "as-is" Creation date: (6/20/00 3:27:10 PM)
 java.lang.String getSessionIdHtmlField()
          Returns the current session identifier string as an HTML hidden field.
 java.lang.String getSessionIdParameter()
          Returns the current session identifier string as a URL parameter.
 java.lang.String getStringValue(java.lang.String name)
          Returns the specified value from the operation context as a string.
 java.lang.String[] getValidationErrorList()
          Returns all validation errors in a single list array.
 java.lang.Object getValue(java.lang.String name)
          Returns the named value from the context in its natural format.
 boolean isFieldHidden(java.lang.String name)
          Returns the "hidden" status of the named field in the context.
 boolean isFieldInError(java.lang.String name)
          Returns the error status of the named field in the context.
 boolean isFieldMandatory(java.lang.String name)
          Returns the "input mandatory" status of the named field in the context.
 boolean isFieldReadOnly(java.lang.String name)
          Returns the "read only" status of the named field in the context.
 boolean isThereAnyError()
          Returns whether there has been any error during the validation process
 void removeDataElementFromTransitionContext(java.lang.String transitionName, java.lang.String dataName)
          Removes a data element from the the transition context for the specified transition
 void setErrorDecorationPrefix(java.lang.String pfx)
          Sets up the error decorator prefix.
 void setErrorDecorationSuffix(java.lang.String sfx)
          Sets up the error decorator suffix.
 void setErrorMarker(java.lang.String newmarker)
          Sets up the error marker value.
 void setTransitionParameter(java.lang.String transitionName, java.lang.String paramName, java.lang.String paramValue)
          Sets a parameter given by paramName with a value given by paramValue for a transitionName of this state
 

Field Detail

COPYRIGHT

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

addDataElementToTransitionContext

void addDataElementToTransitionContext(java.lang.String transitionName,
                                       java.lang.String dataName)
                                       throws DSEException
Add a data element in the the transition context for the specified transition

Parameters:
String - - The transition name
String - - The name of the data element to be added
Throws:
DSEException

createTransitionContext

void createTransitionContext(java.lang.String transitionName,
                             Vector dataNames)
                             throws DSEException
Create a transiton context for the specified transition with the set of dataNames

Parameters:
String - - The transition name
Vector - - A vector with the data element names to be added
Throws:
DSEException

getBaseWebPath

java.lang.String getBaseWebPath()
Obtain the relative path (relative to the web app server web path) for jsp resources. Creation date: (6/21/00 5:38:55 PM)

Returns:
java.lang.String

getContext

Context getContext()
Get the operation context for the page which initialized this bean. Creation date: (6/20/00 12:50:57 PM)

Returns:
com.ibm.btt.base.Context

getCrossValidationErrorList

java.lang.String[] getCrossValidationErrorList()
Return the current list of cross validation errors. Creation date: (6/23/00 11:31:45 AM)

Returns:
java.lang.String[]

getElement

DataElement getElement(java.lang.String name)
Returns the named data element from the context. If the element is not present in the context, null is returned. Creation date: (6/22/00 2:46:27 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.Object

getErrorInfo

ErrorInfo getErrorInfo(java.lang.String name)
Returns the error info object associated to the named field in the context.

Returns:
ErrorInfo

getErrorPageHtml

java.lang.String getErrorPageHtml(java.lang.String name)
Return the error page name

Returns:
String - The error page html.

getException

DSEException getException()
If the toolkit placed an exception in the HttpServletRequest with key name dseexception, then it can be saved here when the bean is initialized. Creation date: (6/20/00 2:52:32 PM)

Returns:
com.ibm.btt.base.DSEException

getExceptionMessage

java.lang.String getExceptionMessage()
Return message text cooresponding to the current exception. Creation date: (6/20/00 12:56:19 PM)

Parameters:
param - javax.servlet.jsp.JspWriter

getFieldErrorMarker

java.lang.String getFieldErrorMarker(java.lang.String name)
Return the current error marker only if the given field is in error. Creation date: (6/22/00 4:52:56 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.String

getFieldLabel

java.lang.String getFieldLabel(java.lang.String name)
Returns the label associated with the given field in the context. Creation date: (6/22/00 1:22:11 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.String

getFieldValidationError

java.lang.String getFieldValidationError(java.lang.String name,
                                         int idx)
Return the field error message text at the specified index. This method returns a blank string if the field has no errors. Creation date: (6/23/00 12:13:19 PM)

Parameters:
name - java.lang.String
idx - int
Returns:
java.lang.String

getFieldValidationErrorDecorated

java.lang.String getFieldValidationErrorDecorated(java.lang.String name,
                                                  int idx)
Return the field error message text at the specified index decorated with prefix and suffix HTML strings. This method returns a blank string if the field has no errors. Creation date: (6/23/00 12:13:19 PM)

Parameters:
name - java.lang.String
idx - int
Returns:
java.lang.String

getFieldValidationErrorList

java.lang.String[] getFieldValidationErrorList(java.lang.String name)
Retrieve the entire error list for the field. An array of zero size is returned if there are no errors associated with the field. Creation date: (6/23/00 12:30:22 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.String[]

getInputDataInError

java.lang.String getInputDataInError(java.lang.String name)
Returns the value of the wrong data typed by the user. This data is considered to be wrong according to the validation process. The typed data is stored in the ErrorInfo object associated to the named field

Returns:
String

getJspFormatErrorList

java.lang.String[] getJspFormatErrorList()
Returns the list of Jsp Format Errors that were found during Jsp Processing. Creation date: (7/5/00 3:12:40 PM)

Returns:
java.lang.String[]

getLinkToPage

java.lang.String getLinkToPage(java.lang.String webPath,
                               java.lang.String pageName,
                               java.lang.String linkText)
Emit the Html to the JspWriter stream to create a link with given text to a given JSP saved in a given web path (relative to the base JSP path for the application server). The link will include the session id using URL rewriting. Creation date: (6/20/00 3:39:50 PM)

Parameters:
param - javax.servlet.jsp.JspWriter
webPath - java.lang.String
pageName - java.lang.String
linkText - java.lang.String

getLocaleId

java.lang.String getLocaleId()
Obtain any extra path information passed on the call to establish the session. For example, if the URL was invoked as:
http://.../CSEstablishSessionServlet/en
then the locale id is the string en. Creation date: (6/21/00 5:38:55 PM)

Returns:
java.lang.String

getRequiredHtmlFields

java.lang.String getRequiredHtmlFields()
Returns an string containing the HTML for all of the HTML Client required fields.

Returns:
java.lang.String

getRequiredHtmlFields

java.lang.String getRequiredHtmlFields(java.lang.String parentctx,
                                       java.lang.String opname)
Returns an string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information.

Parameters:
parentctx - java.lang.String
opname - java.lang.String
Returns:
java.lang.String

getRequiredHtmlFieldsForGETMethod

java.lang.String getRequiredHtmlFieldsForGETMethod()
Returns a string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information. If no opName is specified, assume that this page is being displayed within a processor flow, so the processor name is got from the table of stored processors. The returned String is for use as part of an URL. The format is the needed to be sent via the GET method: param1=value1¶m2=value2&...¶mN=valueN

Returns:
String - The required fields html in the format needed to send using the GET method.

getRequiredHtmlFieldsForGETMethod

java.lang.String getRequiredHtmlFieldsForGETMethod(java.lang.String parentctx,
                                                   java.lang.String opname)
Returns an string containing the HTML for all of the HTML Client required fields using the passed parameters to fill in the user specifiable information. The returned String is for use as part of an URL. The format is the needed to be sent via the GET method: param1=value1¶m2=value2&...¶mN=valueN

Parameters:
parentctx - java.lang.String
opname - java.lang.String
Returns:
java.lang.String

getSessionId

java.lang.String getSessionId()
Returns the current session identifier string "as-is" Creation date: (6/20/00 3:27:10 PM)

Returns:
java.lang.String

getSessionIdHtmlField

java.lang.String getSessionIdHtmlField()
Returns the current session identifier string as an HTML hidden field. Creation date: (6/22/00 2:27:48 PM)

Returns:
java.lang.String

getSessionIdParameter

java.lang.String getSessionIdParameter()
Returns the current session identifier string as a URL parameter. Creation date: (6/22/00 1:41:24 PM)

Returns:
java.lang.String

getStringValue

java.lang.String getStringValue(java.lang.String name)
Returns the specified value from the operation context as a string. Handles exceptions by returning a null string value. Creation date: (6/22/00 1:22:11 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.String

getValidationErrorList

java.lang.String[] getValidationErrorList()
Returns all validation errors in a single list array. Creation date: (6/23/00 11:31:14 AM)

Returns:
java.lang.String[]

getValue

java.lang.Object getValue(java.lang.String name)
Returns the named value from the context in its natural format. If the element is not present in the context, null is returned. Creation date: (6/22/00 2:46:27 PM)

Parameters:
name - java.lang.String
Returns:
java.lang.Object

isFieldHidden

boolean isFieldHidden(java.lang.String name)
Returns the "hidden" status of the named field in the context. Creation date: (6/22/00 4:57:08 PM)

Parameters:
name - java.lang.String
Returns:
boolean

isFieldInError

boolean isFieldInError(java.lang.String name)
Returns the error status of the named field in the context. Creation date: (6/22/00 4:57:08 PM)

Parameters:
name - java.lang.String
Returns:
boolean

isFieldMandatory

boolean isFieldMandatory(java.lang.String name)
Returns the "input mandatory" status of the named field in the context. Creation date: (6/22/00 4:57:08 PM)

Parameters:
name - java.lang.String
Returns:
boolean

isFieldReadOnly

boolean isFieldReadOnly(java.lang.String name)
Returns the "read only" status of the named field in the context. Creation date: (6/22/00 4:57:08 PM)

Parameters:
name - java.lang.String
Returns:
boolean

isThereAnyError

boolean isThereAnyError()
Returns whether there has been any error during the validation process

Returns:
boolean

removeDataElementFromTransitionContext

void removeDataElementFromTransitionContext(java.lang.String transitionName,
                                            java.lang.String dataName)
                                            throws DSEException
Removes a data element from the the transition context for the specified transition

Parameters:
String - - The transition name
String - - The name of the data element to be removed
Throws:
DSEException

setErrorDecorationPrefix

void setErrorDecorationPrefix(java.lang.String pfx)
Sets up the error decorator prefix. This prefix is prepended to any error information returned in a "decorated" error string. Creation date: (6/23/00 2:17:22 PM)

Parameters:
pfx - java.lang.String

setErrorDecorationSuffix

void setErrorDecorationSuffix(java.lang.String sfx)
Sets up the error decorator suffix. This suffix is appended to any error information returned in a "decorated" error string. Creation date: (6/23/00 2:17:22 PM)

Parameters:
pfx - java.lang.String

setErrorMarker

void setErrorMarker(java.lang.String newmarker)
Sets up the error marker value. This is the string that is returned by the "getFieldErrorMarker" method if the field is found to be in error. Creation date: (6/22/00 5:03:20 PM)

Parameters:
newmarker - java.lang.String

setTransitionParameter

void setTransitionParameter(java.lang.String transitionName,
                            java.lang.String paramName,
                            java.lang.String paramValue)
                            throws DSEObjectNotFoundException
Sets a parameter given by paramName with a value given by paramValue for a transitionName of this state

Parameters:
String - - The transitionName
String - - The parameter name
String - - The parameter value
Throws:
DSEObjectNotFoundException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010