com.ibm.bpe.api
Interface WebClientSetting

All Superinterfaces:
ClientSetting, java.lang.Cloneable, java.io.Serializable

public interface WebClientSetting
extends ClientSetting

Interface for Web client settings. Web client settings extend the client settings with the ability to associate a set of usage patterns with a URL.

A sample web client setting follows:
<wpc:webClientSettings clientType="WPC Web Client">
 <wpc:jsp for="info" uri="approveInfo.jsp"/>
 <wpc:jsp for="input" uri="approveInput.jsp"/>
 <wpc:jsp for="output" uri="approveOutput.jsp"/>
 <wpc:jsp for="map" uri="approveMap.jsp"/>
</wpc:webClientSettings>

Since:
5.1

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 JspApplicableRoleEnum[] getApplicableRoles()
          Returns the roles the currently logged-on user belongs to.
 JspLocation getJspLocation(JspUsageEnum usage)
          Returns the JSP location for a given usage pattern.
 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.
 
Methods inherited from interface com.ibm.bpe.api.ClientSetting
getClientType, getCustomSetting, getCustomSettingNames
 

Field Detail

COPYRIGHT

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

getApplicableRoles

JspApplicableRoleEnum[] getApplicableRoles()
Returns the roles the currently logged-on user belongs to.

Returns:
JspApplicableRoleEnum[] - An array of roles the currently logged-on user belongs to. Returns an empty array when there are no applicable roles.
Since:
6.0

getJspLocation

JspLocation getJspLocation(JspUsageEnum usage)
Returns the JSP location for a given usage pattern. If the specified usage pattern is not specified, null is returned.

Parameters:
usage - The pattern for which a JSP location is to be returned.
Returns:
JspLocation - The JSP location that is associated with the specified usage pattern.

getJspLocations

JspLocation[] getJspLocations(JspUsageEnum usage)
Returns the JSP locations for the specified usage pattern, if any. If no usage pattern is specified, null is returned.

Parameters:
usage - The usage pattern for which a JSP location is to be returned - see JspUsageEnum.
Returns:
JspLocation[] - An array of all JSP locations that are associated with the specified usage pattern. Returns an empty array, when there are no JSP locations.
Since:
6.0

getJspLocation

JspLocation getJspLocation(JspUsageEnum usage,
                           JspApplicableRoleEnum applicableRole)
Returns the JSP location for the specified usage pattern and role. If a usage pattern or role is not specified, null is returned. Note:To determine the JspLocation for a fault (JspUsageEnum.FAULT), use getJspLocation(String, JspApplicableRoleEnum). The fault name must be specified as an additional parameter since there can be a JspLocation per fault.

Parameters:
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.
Returns:
JspLocation - The JSP location that is associated with the specified usage pattern and role.
Since:
6.0

getJspLocation

JspLocation getJspLocation(java.lang.String faultName,
                           JspApplicableRoleEnum applicableRole)
Returns the JSP location for the usage pattern fault and the specified fault name and role. If the fault name or the role are not specified, null is returned.

Parameters:
faultName - The fault name for which the JSP location is to be returned. Note that the structure of the fault name is a QName.
applicableRole - The role for which the JSP location is to be returned - JspApplicableRoleEnum.
Returns:
JspLocation - The JSP location that is associated with the specified fault name and role.
Since:
6.0