public interface WebClientSetting extends ClientSetting
A sample web client setting follows:
<wpc:webClientSettings clientType="HTM Web Client">
<wpc:jsp for="page" uri="approvePage.jsp"/>
<wpc:jsp for="input" uri="approveInput.jsp"/>
<wpc:jsp for="output" uri="approveOutput.jsp"/>
<wpc:jsp for="map" uri="approveMap.jsp"/>
</wpc:webClientSettings>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
Modifier and Type | Method and Description |
---|---|
JspApplicableRoleEnum[] |
getApplicableRoles()
Returns the roles the currently logged-on user belongs to.
|
JspLocation |
getJspLocation(JspUsageEnum usage)
Returns the JSP location for the specified usage pattern, if any.
|
JspLocation |
getJspLocation(JspUsageEnum usage,
JspApplicableRoleEnum applicableRole)
Returns the JSP location for the specified usage pattern and role.
|
JspLocation |
getJspLocation(java.lang.String faultName,
JspApplicableRoleEnum applicableRole)
Returns the JSP location for the usage pattern
fault and the
specified fault name and role. |
JspLocation[] |
getJspLocations(JspUsageEnum usage)
Returns the JSP locations for the specified usage pattern, if any.
|
getClientType, getCustomSetting, getCustomSettingNames
static final java.lang.String COPYRIGHT
JspApplicableRoleEnum[] getApplicableRoles()
JspLocation getJspLocation(JspUsageEnum usage)
usage
- The pattern for which a JSP location is to be returned.JspLocation[] getJspLocations(JspUsageEnum usage)
usage
- The usage pattern for which a JSP location is to be returned - see
JspUsageEnum
.JspLocation getJspLocation(JspUsageEnum usage, JspApplicableRoleEnum applicableRole)
JspUsageEnum.FAULT
),
use getJspLocation(String, JspApplicableRoleEnum)
. The fault name must be
specified as an additional parameter since there can be a JspLocation per fault.usage
- The usage pattern for which a JSP location is to be returned - see
JspUsageEnum
.applicableRole
- The role for which a JSP location is to be returned - see
JspApplicableRoleEnum
.JspLocation getJspLocation(java.lang.String faultName, JspApplicableRoleEnum applicableRole)
fault
and the
specified fault name and role.
If the fault name or the role are not specified, null is returned.faultName
- The fault name for which the JSP location is to be returned.applicableRole
- The role for which the JSP location is to be returned -
JspApplicableRoleEnum
.