|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.cs.html.DSEJspContextServices
public class DSEJspContextServices
This class implements the JspContextServices interface.
It receives the operation context from the request and provides various interfaces to access the context information.
Field Summary | |
---|---|
protected java.lang.String |
applicationID
The application session id string * |
protected Context |
applicationSessionContext
The application session context * |
protected java.lang.String |
baseWebApplURIPath
the Web Application URI plus base path * |
protected java.lang.String |
baseWebPath
The base web path string * |
protected DSEException |
dseexception
The current operation exception * |
protected java.lang.String |
errorMarker
The error marker value * |
protected java.lang.String |
errorPrefix
The error decorator "prefix" value * |
protected java.lang.String |
errorSuffix
The error decorator "suffix" value * |
protected Vector |
errsJsp
The JSP format errors list * |
protected java.lang.String[] |
errsVal
The validation errors list * |
protected java.lang.String[] |
errsXVal
The cross-validation errors list * |
protected java.lang.String |
extraPathInfo
The locale (extra path) string |
protected Context |
operationContext
The operation context |
protected java.lang.String |
pageId
The pageId for the displaying page * |
protected java.lang.String |
processorID
The processor ID * |
protected java.lang.String |
processorName
The processor name * |
protected Context |
sessionContext
The session context |
protected java.lang.String |
sessionID
The session id string * |
protected java.lang.String |
webApplURI
the Web Application URI * |
Constructor Summary | |
---|---|
DSEJspContextServices()
DSEJspContextServices default constructor. |
Method Summary | |
---|---|
void |
addDataElementToTransitionContext(java.lang.String transitionName,
java.lang.String dataName)
Adds a data element in the the transition context for the specified transition |
double |
asDouble(java.lang.String strval)
Useful service for converting a String into it's equivalent double value. |
float |
asFloat(java.lang.String strval)
Useful service for converting a String into it's equivalent float value. |
int |
asInt(java.lang.String strval)
Useful service for converting a String into it's equivalent integer value. |
long |
asLong(java.lang.String strval)
Useful service for converting a String into it's equivalent long value. |
void |
createTransitionContext(java.lang.String transitionName,
Vector dataNames)
Creates a transiton context for the specified transition with the set of dataNames |
java.lang.String |
getApplicationIdHtmlField()
Returns the current application session identifier string as an HTML hidden field. |
java.lang.String |
getApplicationIdParameter()
Returns the current application identifier string as a URL parameter. |
Context |
getApplicationSessionContext()
Return the application session context for the page which initialized this bean. |
java.lang.String |
getApplicationSessionId()
Returns the current application session identifier string "as-is". |
java.lang.String |
getBaseWebApplURIPath()
Gets the baseWebApplURIPath |
java.lang.String |
getBaseWebPath()
Obtain the relative 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 operation context. |
protected DataElement |
getElement(java.lang.String name,
boolean useSess)
Insert the method's description here. |
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 information passed on the call to establish the session. |
java.lang.String |
getRequiredHtmlFields()
Returns a string containing the HTML for all of the HTML Client required fields using the current processor name gotten from the table of stored processors. |
java.lang.String |
getRequiredHtmlFields(java.lang.String parentCtx,
java.lang.String opName)
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()
Returns a string containing the HTML for all of the HTML Client required fields using the current processor name gotten from the table of stored processors. |
java.lang.String |
getRequiredHtmlFieldsForGETMethod(java.lang.String parentCtx,
java.lang.String opName)
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. |
Context |
getSessionContext()
Return the session context for the page which initialized this bean. |
DataElement |
getSessionElement(java.lang.String name)
Returns the named data element from the session context. |
java.lang.String |
getSessionId()
Returns the current session identifier string "as-is". |
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 |
getSessionStringValue(java.lang.String name)
Returns the specified value from the session context as a string. |
java.lang.Object |
getSessionValue(java.lang.String name)
Returns the named value from the session context in its natural format. |
java.lang.String |
getStringValue(java.lang.String name)
Returns the specified value from the operation context as a string. |
protected java.lang.String |
getStringValue(java.lang.String name,
boolean useSess)
Deprecated. Replaced by getStringValue(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 operation context in its natural format. |
protected java.lang.Object |
getValue(java.lang.String name,
boolean useSess)
Deprecated. Replaced by getValue(String) . |
java.lang.String |
getWebApplURI()
Gets the webApplURI |
void |
initialize(javax.servlet.http.HttpServletRequest request)
The HttpServletRequest is supposed to have references to the operation context and exceptions placed by the toolkit during handling of the request. |
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. |
protected void |
setException(DSEException newException)
If the toolkit placed an exception in the HttpServletRequest with key name dseexception, then it can be saved here when the bean is initialized. |
protected void |
setJspFormatError(java.lang.Exception xcp,
java.lang.String name)
Updates the JspFormatErrorList with information about the error occurred. |
protected void |
setJspFormatError(java.lang.Exception xcp,
java.lang.String name,
boolean useSess)
Deprecated. Replaced by setJspFormatError(Exception ,String) . |
protected void |
setJspFormatError(java.lang.String text)
Updates the JspFormatErrorList with information about the error occurred. |
protected void |
setOperationAndSessionContext(javax.servlet.http.HttpServletRequest req)
Save the operation context, and use it to obtain the session context, which is saved as well. |
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 |
void |
setWebAttributes(javax.servlet.http.HttpServletRequest request)
This method sets the URI attributes from the request |
java.lang.String[] |
translateErrors(ErrorInfo errInfo)
Translate the field error message |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Context operationContext
protected Context sessionContext
protected DSEException dseexception
protected java.lang.String baseWebPath
protected java.lang.String extraPathInfo
protected java.lang.String sessionID
protected java.lang.String errorMarker
protected java.lang.String errorPrefix
protected java.lang.String errorSuffix
protected java.lang.String[] errsVal
protected java.lang.String[] errsXVal
protected Vector errsJsp
protected java.lang.String pageId
protected java.lang.String applicationID
protected Context applicationSessionContext
protected java.lang.String processorName
protected java.lang.String processorID
protected java.lang.String webApplURI
protected java.lang.String baseWebApplURIPath
Constructor Detail |
---|
public DSEJspContextServices()
Method Detail |
---|
public void addDataElementToTransitionContext(java.lang.String transitionName, java.lang.String dataName) throws DSEException
addDataElementToTransitionContext
in interface JspContextServices
String
- -
The transition nameString
- -
The name of the data element to be added
DSEException
public double asDouble(java.lang.String strval)
public float asFloat(java.lang.String strval)
public int asInt(java.lang.String strval)
public long asLong(java.lang.String strval)
public void createTransitionContext(java.lang.String transitionName, Vector dataNames) throws DSEException
createTransitionContext
in interface JspContextServices
String
- -
The transition nameVector
- -
A vector with the data element names to be added
DSEException
public java.lang.String getApplicationIdHtmlField()
public java.lang.String getApplicationIdParameter()
public Context getApplicationSessionContext()
public java.lang.String getApplicationSessionId()
public java.lang.String getBaseWebApplURIPath()
public java.lang.String getBaseWebPath()
Relative to the web app server web path
getBaseWebPath
in interface JspContextServices
public Context getContext()
getContext
in interface JspContextServices
public java.lang.String[] getCrossValidationErrorList()
getCrossValidationErrorList
in interface JspContextServices
public DataElement getElement(java.lang.String name)
If the element is not present in the context, null is returned.
getElement
in interface JspContextServices
name
- java.lang.String
protected DataElement getElement(java.lang.String name, boolean useSess)
name
- java.lang.StringuseSess
- boolean
public ErrorInfo getErrorInfo(java.lang.String name)
getErrorInfo
in interface JspContextServices
public java.lang.String getErrorPageHtml(java.lang.String name)
getErrorPageHtml
in interface JspContextServices
public DSEException getException()
getException
in interface JspContextServices
public java.lang.String getExceptionMessage()
getExceptionMessage
in interface JspContextServices
public java.lang.String getFieldErrorMarker(java.lang.String name)
Returns a blank string if no error exists.
getFieldErrorMarker
in interface JspContextServices
name
- java.lang.String
public java.lang.String getFieldLabel(java.lang.String name)
getFieldLabel
in interface JspContextServices
name
- java.lang.String
public java.lang.String getFieldValidationError(java.lang.String name, int idx)
This method returns a blank string if the field has no errors.
getFieldValidationError
in interface JspContextServices
name
- java.lang.Stringidx
- int
public java.lang.String getFieldValidationErrorDecorated(java.lang.String name, int idx)
This method returns a blank string if the field has no errors.
getFieldValidationErrorDecorated
in interface JspContextServices
name
- java.lang.Stringidx
- int
public java.lang.String[] getFieldValidationErrorList(java.lang.String name)
An array of zero size is returned if there are no errors associated with the field.
null is returned if there is not an element matching with the name provided as a parameter.
getFieldValidationErrorList
in interface JspContextServices
name
- java.lang.String
public java.lang.String getInputDataInError(java.lang.String name)
getInputDataInError
in interface JspContextServices
public java.lang.String[] getJspFormatErrorList()
getJspFormatErrorList
in interface JspContextServices
public java.lang.String getLinkToPage(java.lang.String webPath, java.lang.String pageName, java.lang.String linkText)
getLinkToPage
in interface JspContextServices
webPath
- java.lang.StringpageName
- java.lang.StringlinkText
- java.lang.String
public java.lang.String getLocaleId()
getLocaleId
in interface JspContextServices
public java.lang.String getRequiredHtmlFields()
getRequiredHtmlFields
in interface JspContextServices
public java.lang.String getRequiredHtmlFields(java.lang.String parentCtx, java.lang.String opName)
getRequiredHtmlFields
in interface JspContextServices
parentctx
- java.lang.Stringopname
- java.lang.String
public java.lang.String getRequiredHtmlFieldsForGETMethod()
getRequiredHtmlFieldsForGETMethod
in interface JspContextServices
public java.lang.String getRequiredHtmlFieldsForGETMethod(java.lang.String parentCtx, java.lang.String opName)
getRequiredHtmlFieldsForGETMethod
in interface JspContextServices
parentctx
- java.lang.Stringopname
- java.lang.String
public Context getSessionContext()
public DataElement getSessionElement(java.lang.String name)
If the element is not present in the context, null is returned.
public java.lang.String getSessionId()
getSessionId
in interface JspContextServices
public java.lang.String getSessionIdHtmlField()
getSessionIdHtmlField
in interface JspContextServices
public java.lang.String getSessionIdParameter()
getSessionIdParameter
in interface JspContextServices
public java.lang.String getSessionStringValue(java.lang.String name)
Handles exceptions by returning a null string value.
public java.lang.Object getSessionValue(java.lang.String name)
If the element is not present in the context, null is returned.
public java.lang.String getStringValue(java.lang.String name)
Handles exceptions by returning a null string value.
getStringValue
in interface JspContextServices
name
- java.lang.String
protected java.lang.String getStringValue(java.lang.String name, boolean useSess)
getStringValue(String)
.
ctx
- com.ibm.btt.base.Contextname
- java.lang.String
public java.lang.String[] getValidationErrorList()
getValidationErrorList
in interface JspContextServices
public java.lang.Object getValue(java.lang.String name)
If the element is not present in the context hierarchy, null is returned.
getValue
in interface JspContextServices
name
- java.lang.String
protected java.lang.Object getValue(java.lang.String name, boolean useSess)
getValue(String)
.
name
- java.lang.StringuseSess
- boolean
public java.lang.String getWebApplURI()
public void initialize(javax.servlet.http.HttpServletRequest request) throws DSEException
request
- javax.servlet.http.HttpServletRequest
DSEException
public boolean isFieldHidden(java.lang.String name)
isFieldHidden
in interface JspContextServices
name
- java.lang.String
public boolean isFieldInError(java.lang.String name)
isFieldInError
in interface JspContextServices
name
- java.lang.String
public boolean isFieldMandatory(java.lang.String name)
isFieldMandatory
in interface JspContextServices
name
- java.lang.String
public boolean isFieldReadOnly(java.lang.String name)
isFieldReadOnly
in interface JspContextServices
name
- java.lang.String
public boolean isThereAnyError()
isThereAnyError
in interface JspContextServices
public void removeDataElementFromTransitionContext(java.lang.String transitionName, java.lang.String dataName) throws DSEException
removeDataElementFromTransitionContext
in interface JspContextServices
String
- -
The transition nameString
- -
The name of the data element to be removed
DSEException
public void setErrorDecorationPrefix(java.lang.String pfx)
This prefix is prepended to any error information returned in a "decorated" error string.
setErrorDecorationPrefix
in interface JspContextServices
pfx
- java.lang.Stringpublic void setErrorDecorationSuffix(java.lang.String sfx)
This suffix is appended to any error information returned in a "decorated" error string.
setErrorDecorationSuffix
in interface JspContextServices
public void setErrorMarker(java.lang.String newmarker)
This is the string that is returned by the "getFieldErrorMarker" method if the field is found to be in error.
setErrorMarker
in interface JspContextServices
newmarker
- java.lang.Stringprotected void setException(DSEException newException)
newException
- com.ibm.btt.base.DSEExceptionprotected void setJspFormatError(java.lang.Exception xcp, java.lang.String name)
text
- java.lang.Stringprotected void setJspFormatError(java.lang.Exception xcp, java.lang.String name, boolean useSess)
setJspFormatError(Exception ,String)
.
text
- java.lang.Stringprotected void setJspFormatError(java.lang.String text)
text
- java.lang.Stringprotected void setOperationAndSessionContext(javax.servlet.http.HttpServletRequest req) throws DSEException
newOperationContext
- com.ibm.btt.base.Context
DSEException
public void setTransitionParameter(java.lang.String transitionName, java.lang.String paramName, java.lang.String paramValue) throws DSEObjectNotFoundException
setTransitionParameter
in interface JspContextServices
String
- -
The transitionNameString
- -
The parameter nameString
- -
The parameter value
DSEObjectNotFoundException
public void setWebAttributes(javax.servlet.http.HttpServletRequest request) throws DSEException
request
- javax.servlet.http.HttpServletRequest
DSEException
public java.lang.String[] translateErrors(ErrorInfo errInfo)
errInfo
- The errorInfo of the dataElement
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |