JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.comm
Class AdfXMLRequest

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.comm.AdfXMLRequest

public class AdfXMLRequest
extends AdfObject

Default constructor. Creates an asynchronous XML HTTP request

Field Summary

public Object	callback
private static Object	_CHECKPOINT
public static Object	COMPLETED
public Object	headers
public static Object	INTERACTIVE
public Object	isSynchronous
public static Object	LOADED
public static Object	LOADING
private Object	_state
public static Object	UNINITIALIZED Request state constants.
public Object	xmlhttp

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfXMLRequest() Default constructor.

Method Summary

public Object	abort() Aborts an XML HTTP request
public Object	addEventListener(Object event, Object listener) Adds an Event Listener to the request
public Object	cleanup()
public Object	getAllResponseHeaders()
public Object	getCompletionState() Returns request's completion state (see Request state constants)
public Object	getResponseHeader(Object name)
public Object	getResponseText() Returns the response as text Note:
public Object	getResponseXML() Returns the response as an XML document Note:
public Object	getStatus() Returns the HTTP response status.
protected Object	Init() Initializes the instance.
public Object	send(Object url, Object content, Object ommitAdfRichMessage) Sends an XML HTTP request Parameters:
public Object	setCallback(Object _callback) Registers request callback for asynchronous requests The callback will be called each time the state of the request changes (see getCompletionState()) The callback should have the following siganture:
public Object	setRequestHeader(Object name, Object value)
public Object	setSynchronous(Object isSynch) Specifies whether the request should be synchronous Parameters:
private static Object	_startCheckpoint()
private static Object	_stopCheckpoint()
public Object	toString() Override for debugging

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString

Field Detail

callback

public Object callback

_CHECKPOINT

private static Object _CHECKPOINT

COMPLETED

public static Object COMPLETED

headers

public Object headers

INTERACTIVE

public static Object INTERACTIVE

isSynchronous

public Object isSynchronous

LOADED

public static Object LOADED

LOADING

public static Object LOADING

_state

private Object _state

UNINITIALIZED

public static Object UNINITIALIZED

Request state constants. See getCompletionState()

xmlhttp

public Object xmlhttp

Constructor Detail

AdfXMLRequest

public AdfXMLRequest()

Default constructor. Creates an asynchronous XML HTTP request

Method Detail

abort

public Object abort()

Aborts an XML HTTP request

Return:

Object

addEventListener

public Object addEventListener(Object event,
Object listener)

Adds an Event Listener to the request

Parameters:

event	-	event, such as "progress".
listener	-	listener which will be called.

Return:

Object

cleanup

public Object cleanup()

Return:

Object

getAllResponseHeaders

public Object getAllResponseHeaders()

Return:

Object

getCompletionState

public Object getCompletionState()

Returns request's completion state (see Request state constants)

Return:

Object

getResponseHeader

public Object getResponseHeader(Object name)

Parameters:

name

Return:

Object

getResponseText

public Object getResponseText()

Returns the response as text Note: this method will block if the the request is asynchronous and has not yet been completed

Return:

Object

getResponseXML

public Object getResponseXML()

Returns the response as an XML document Note: this method will block if the the request is asynchronous and has not yet been completed

Return:

Object

getStatus

public Object getStatus()

Returns the HTTP response status. For example, 200 is OK.

Return:

Object

Init

protected Object Init()

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Return:

Object

Overrides:

AdfObject.Init()

send

public Object send(Object url,
Object content,
Object ommitAdfRichMessage)

Sends an XML HTTP request Parameters: url - destination URL content - XML document or string that should be included in the request's body ommitAdfRichMessage (optional parameter) - true if "Adf-Rich-Message" header parameter should not be sent to the server

Parameters:

url
content
ommitAdfRichMessage

Return:

Object

setCallback

public Object setCallback(Object _callback)

Registers request callback for asynchronous requests The callback will be called each time the state of the request changes (see getCompletionState()) The callback should have the following siganture: <void> function (<AdfXMLRequest>request)

Parameters:

_callback

Return:

Object

setRequestHeader

public Object setRequestHeader(Object name,
Object value)

Parameters:

name
value

Return:

Object

setSynchronous

public Object setSynchronous(Object isSynch)

Specifies whether the request should be synchronous Parameters: isSynch - true if request should be synchronous, false otherwise

Parameters:

isSynch

Return:

Object

_startCheckpoint

private static Object _startCheckpoint()

Return:

Object

_stopCheckpoint

private static Object _stopCheckpoint()

Return:

Object

toString

public Object toString()

Override for debugging

Return:

Object

Overrides:

AdfObject.toString()

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD