com.ibm.bpe.api
Interface JspLocation

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

public interface JspLocation
extends java.io.Serializable, java.lang.Cloneable

Interface to retrieve JSP locations of a Web client setting.

A <jsp> element is defined as follows:
<wpc:webClientSettings clientType="Web Client">
 <wpc:customSetting name="name" value="value"?>*
 <wpc:jsp for="page|info|input|output|map|template|instance" uri="jspURI" contextRoot="contextRoot">+
</wpc:webClientSettings>?

Since:
5.1
See Also:
JspUsageEnum, WebClientSetting

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.util.List getApplyTo()
          Returns the roles that are associated with this JSP location.
 java.lang.String getContextRoot()
          Returns the context root of the JSP.
 java.lang.String getFaultName()
          Returns the fault name provided that the JSP location describes a JSP for a fault.
 java.net.URI getUri()
          Returns the URI of the JSP.
 java.lang.String getUriAsString()
          Returns the URI of the JSP represented as a string.
 

Field Detail

COPYRIGHT

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

getUriAsString

public java.lang.String getUriAsString()
Returns the URI of the JSP represented as a string.

Returns:
String - A string representation of the URI.

getUri

public java.net.URI getUri()
Returns the URI of the JSP.

Returns:
URI - The URI of the JSP.
Since:
6.0.2

getContextRoot

public java.lang.String getContextRoot()
Returns the context root of the JSP. Returns null when the context root is not set.

Returns:
String - The context root of the JSP.

getApplyTo

public java.util.List getApplyTo()
Returns the roles that are associated with this JSP location.

Returns:
List - List of JspApplicableRoleEnum objects. Refer to JspApplicableRoleEnum
Since:
6.0

getFaultName

public java.lang.String getFaultName()
Returns the fault name provided that the JSP location describes a JSP for a fault. Returns null when the JSP location does not describe a fault JSP.

Returns:
String - The fault name when the JSP location describes a fault JSP; otherwise null. Note:The structure of a fault name is a QName.
Since:
6.0