A C D E G H I L O P S T U W

A

addHeader(String, String) - Method in class oracle.webclipping.bean.WebClippingRequest

Allows manipulation of Web Clipping Headers.

addParam(String, String) - Method in class oracle.webclipping.bean.WebClippingRequest

Allows manipulation of Web Clipping Parameters.

APPLICATION_ERROR - Static variable in interface oracle.webclipping.bean.WebClippingExceptionConstants

This is a catch-all error for all application errors that may occur during an execution of a Web Clipping.

C

CANNOT_OPENSTREAM - Static variable in interface oracle.webclipping.bean.WebClippingExceptionConstants

This describes the generic error of problems opening a response stream from the Web Clipping Server.

D

DEF_PREF - Static variable in interface oracle.webclipping.bean.WebClippingConstants

E

execute(WebClippingRequest) - Method in class oracle.webclipping.bean.WebClippingConnection

Heart of the operation; this calls out using HTTP to the Web Clipping Server to execute the Web Clipping and return its responses.

G

getErrorCode() - Method in class oracle.webclipping.bean.WebClippingException

The error code that may hint at the cause of the exception.

getInternalException() - Method in class oracle.webclipping.bean.WebClippingException

Returns the nested Exception.

getLocalizedMessage() - Method in class oracle.webclipping.bean.WebClippingException

Gets the localized error message based on the current default Locale.

getLocalizedMessage(Locale) - Method in class oracle.webclipping.bean.WebClippingException

Get the message localized by the passed in Locale.

getMessage() - Method in class oracle.webclipping.bean.WebClippingException

Gets the localized error message based on the current default Locale.

getRecordName() - Method in interface oracle.webclipping.bean.WebClippingResponse

As we allow nesting of Web Clipping Responses, each Web Clipping Response has a name to refer to.

getRecordShortDescription() - Method in interface oracle.webclipping.bean.WebClippingResponse

In addition to the Record name, there is also a short description to better describe the Response.

H

HDR_CLIP_ID - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The ID of the Clip that is requested for

HDR_MOBILE_LOC_ADDR_LASTLINE - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Address line3 of the location.

HDR_MOBILE_LOC_ADDR_LINE1 - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Address line1 of the location.

HDR_MOBILE_LOC_ADDR_LINE2 - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Address line2 of the location.

HDR_MOBILE_LOC_BLOCK - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Location Block.

HDR_MOBILE_LOC_CITY - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Location City.

HDR_MOBILE_LOC_COMPANY_NAME - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Address company name.

HDR_MOBILE_LOC_COUNTRY - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Country.

HDR_MOBILE_LOC_COUNTY - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Location county.

HDR_MOBILE_LOC_POSTALCODE - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Location zip/postal code.

HDR_MOBILE_LOC_POSTALCODE_EXT - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Extended zip/postal code.

HDR_MOBILE_LOC_STATE - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Location state.

HDR_MOBILE_LOC_TYPE - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Values are "profile" or "auto"

HDR_MOBILE_LOC_X - Static variable in interface oracle.webclipping.bean.WebClippingConstants

X Cord of the location (float)

HDR_MOBILE_LOC_Y - Static variable in interface oracle.webclipping.bean.WebClippingConstants

Y Cord of the location (float)

HDR_MOBILE_USER_AUTHKIND - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The kind of authentication used to login

HDR_MOBILE_USER_DISPNAME - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The display name for the user of the mobile device.

HDR_MOBILE_USER_KIND - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The kind of user that's using the mobile device: logged in or not

HDR_MOBILE_USER_LOCALE - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The locale of the user

HDR_MOBILE_USER_NAME - Static variable in interface oracle.webclipping.bean.WebClippingConstants

The login user name of the mobile device.

I

INTERNAL_ERROR - Static variable in interface oracle.webclipping.bean.WebClippingExceptionConstants

This is a catch-all error for all internal errors that may occur during an execution of a Web Clipping.

INVALID_PROTOCOL - Static variable in interface oracle.webclipping.bean.WebClippingExceptionConstants

This error is very similar to the above case and can only be encountered when the application developer tries to modify the default URL specified in the generated Java template code.

INVALID_URL - Static variable in interface oracle.webclipping.bean.WebClippingExceptionConstants

This error indicates that an invalid URL has been specified for connecting to a Web Clipping Server.

L

LOC_PREF - Static variable in interface oracle.webclipping.bean.WebClippingConstants

O

oracle.webclipping.bean - package oracle.webclipping.bean

Provides Java Bean-like access to Web Clippings so that Wireless applications can be written to take advantage of existing Web Content after one uses the Wireless Web Clipping Studio to "scrape" desired Web pages.

P

printStackTrace() - Method in class oracle.webclipping.bean.WebClippingException

Need to override this because of the nested exception

printStackTrace(PrintStream) - Method in class oracle.webclipping.bean.WebClippingException

Need to override this because of the nested exception

printStackTrace(PrintWriter) - Method in class oracle.webclipping.bean.WebClippingException

Prints the stack trace given a PrintWriter.

S

setClipId(int) - Method in class oracle.webclipping.bean.WebClippingRequest

Sets the Id of the Clip you wish to execute.

setRecordName(String) - Method in interface oracle.webclipping.bean.WebClippingResponse

As we allow nesting of Web Clipping Responses, each Web Clipping Response has a name to refer to.

setRecordShortDescription(String) - Method in interface oracle.webclipping.bean.WebClippingResponse

In addition to the Record name, there is also a short description to better describe the Response.

T

toXml(WebClippingResponse) - Static method in class oracle.webclipping.bean.WebClippingUtil

Convert the WebClippingResponse into Element format

U

USR_PREF - Static variable in interface oracle.webclipping.bean.WebClippingConstants

W

WebClippingConnection - class oracle.webclipping.bean.WebClippingConnection.

This class is the starting point of all communication channels from your Java client to the Web Clipping Server.

WebClippingConnection(String) - Constructor for class oracle.webclipping.bean.WebClippingConnection

Constructs a connection with the Web Clipping Server by passing in a connection url.

WebClippingConstants - interface oracle.webclipping.bean.WebClippingConstants.

This interface defines all the constants that can and are used by the Bean APIs.

WebClippingException - exception oracle.webclipping.bean.WebClippingException.

This Exception class is used to represent all possible errors that can result from an execution of a Web Clipping.

WebClippingExceptionConstants - interface oracle.webclipping.bean.WebClippingExceptionConstants.

This interface embodies the possible exception kinds that can result in an execution flow of a Web Clipping.

WebClippingRequest - class oracle.webclipping.bean.WebClippingRequest.

This class embodies the formal request that is made to a Web Clipping Server URL to execute a particular Web Clipping.

WebClippingRequest(HttpServletRequest) - Constructor for class oracle.webclipping.bean.WebClippingRequest

Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information.

WebClippingRequest(HttpServletRequest, int) - Constructor for class oracle.webclipping.bean.WebClippingRequest

Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information, as well as a Clip Id as it was known at the time of construction.

WebClippingRequest(int) - Constructor for class oracle.webclipping.bean.WebClippingRequest

Constructor of the Web Clipping Request that takes in a Clip Id.

WebClippingResponse - interface oracle.webclipping.bean.WebClippingResponse.

This is the interface that users will use to navigate through the response set that results from an execution of a Web Clipping.

WebClippingUtil - class oracle.webclipping.bean.WebClippingUtil.

This utility class provides miscellaneous methods to operate on the different data structures involved with the Web Clipping bean API.

WebClippingUtil() - Constructor for class oracle.webclipping.bean.WebClippingUtil

writeFormatted(WebClippingResponse, Writer) - Static method in class oracle.webclipping.bean.WebClippingUtil

This method formats the Web Clipping Response and writes to a writer in the default formatting.

A C D E G H I L O P S T U W