|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
void addDataElementToTransitionContext(java.lang.String transitionName, java.lang.String dataName) throws DSEException
String
- -
The transition nameString
- -
The name of the data element to be added
DSEException
void createTransitionContext(java.lang.String transitionName, Vector dataNames) throws DSEException
String
- -
The transition nameVector
- -
A vector with the data element names to be added
DSEException
java.lang.String getBaseWebPath()
Context getContext()
java.lang.String[] getCrossValidationErrorList()
DataElement getElement(java.lang.String name)
name
- java.lang.String
ErrorInfo getErrorInfo(java.lang.String name)
java.lang.String getErrorPageHtml(java.lang.String name)
DSEException getException()
java.lang.String getExceptionMessage()
param
- javax.servlet.jsp.JspWriterjava.lang.String getFieldErrorMarker(java.lang.String name)
name
- java.lang.String
java.lang.String getFieldLabel(java.lang.String name)
name
- java.lang.String
java.lang.String getFieldValidationError(java.lang.String name, int idx)
name
- java.lang.Stringidx
- int
java.lang.String getFieldValidationErrorDecorated(java.lang.String name, int idx)
name
- java.lang.Stringidx
- int
java.lang.String[] getFieldValidationErrorList(java.lang.String name)
name
- java.lang.String
java.lang.String getInputDataInError(java.lang.String name)
java.lang.String[] getJspFormatErrorList()
java.lang.String getLinkToPage(java.lang.String webPath, java.lang.String pageName, java.lang.String linkText)
param
- javax.servlet.jsp.JspWriterwebPath
- java.lang.StringpageName
- java.lang.StringlinkText
- java.lang.Stringjava.lang.String getLocaleId()
java.lang.String getRequiredHtmlFields()
java.lang.String getRequiredHtmlFields(java.lang.String parentctx, java.lang.String opname)
parentctx
- java.lang.Stringopname
- java.lang.String
java.lang.String getRequiredHtmlFieldsForGETMethod()
java.lang.String getRequiredHtmlFieldsForGETMethod(java.lang.String parentctx, java.lang.String opname)
parentctx
- java.lang.Stringopname
- java.lang.String
java.lang.String getSessionId()
java.lang.String getSessionIdHtmlField()
java.lang.String getSessionIdParameter()
java.lang.String getStringValue(java.lang.String name)
name
- java.lang.String
java.lang.String[] getValidationErrorList()
java.lang.Object getValue(java.lang.String name)
name
- java.lang.String
boolean isFieldHidden(java.lang.String name)
name
- java.lang.String
boolean isFieldInError(java.lang.String name)
name
- java.lang.String
boolean isFieldMandatory(java.lang.String name)
name
- java.lang.String
boolean isFieldReadOnly(java.lang.String name)
name
- java.lang.String
boolean isThereAnyError()
void removeDataElementFromTransitionContext(java.lang.String transitionName, java.lang.String dataName) throws DSEException
String
- -
The transition nameString
- -
The name of the data element to be removed
DSEException
void setErrorDecorationPrefix(java.lang.String pfx)
pfx
- java.lang.Stringvoid setErrorDecorationSuffix(java.lang.String sfx)
pfx
- java.lang.Stringvoid setErrorMarker(java.lang.String newmarker)
newmarker
- java.lang.Stringvoid setTransitionParameter(java.lang.String transitionName, java.lang.String paramName, java.lang.String paramValue) throws DSEObjectNotFoundException
String
- -
The transitionNameString
- -
The parameter nameString
- -
The parameter value
DSEObjectNotFoundException
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |