OracleJavaScript API Reference for Oracle ADF Faces

 

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

oracle.adfinternal.view.js.comm
Class AdfOfflineDataTransferService

Warning:

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

public class AdfOfflineDataTransferService
extends AdfDataTransferService
Stub class used when we are offline (attachment mode) to grab and suppress communication to the server



Field Summary


Fields inherited from oracle.adfinternal.view.js.comm.AdfDataTransferService

STATE_BUSY, STATE_READY, TRANSFER_COMPLETE


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

constructor, superclass


Fields inherited from org.ecmascript.object.Object

prototype


Constructor Summary

public
AdfOfflineDataTransferService(Object domWindow)
Stub class used when we are offline (attachment mode) to grab and suppress communication to the server


Method Summary

public Object
addStateChangeListener(Function listener, Object instance)
Adds a listener to the data transfer service that is interested in its state change.
public Object
getDTSState()
Return the current DTS state.
public Object
notifyStreamingRequestComplete()
Notifies Data Transfer Service that the streaming request is done
public Object
pageUnloading()
public Object
processStreamingResponse(Object script)
Called by the script from within the streaming IFRAME
public Object
removeStateChangeListener(Function listener, Object instance)
Removes a listener from the data transfer service that is interested in its state change.
public Object
resume()
Resumes the data transfer service, allowing normally processing to continue.
public Object
sendMultiPartRequest(Object context, Object actionURL, Object htmlForm, Object params, Object listeners)
Performs Asynchronous HTTP Request with the Server for multipart data
public Object
sendPollingRequest(Object actionURL, Object listeners)
This function is only used for long-polling requests and interval polling requests.
public Object
sendRequest(Object context, Object actionURL, Object headerParams, Object content, Object listeners)
Performs Asynchronous XML HTTP Request with the Server
public Object
sendStreamingRequest(Object actionURL, Object params)
Sends a streaming request to the server over an IFRAME
public Boolean
streamingResponsesOutstanding()
public Object
suspend()
Suspends the data transfer service until a matching call to resume() is made.
private Object
_warn()


Methods inherited from oracle.adfinternal.view.js.comm.AdfDataTransferService

dispose, getInstance, InitClass


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

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


Field Detail


Constructor Detail


AdfOfflineDataTransferService

public AdfOfflineDataTransferService(Object domWindow)

Stub class used when we are offline (attachment mode) to grab and suppress communication to the server

Parameters:
domWindow    

Method Detail


addStateChangeListener

public Object addStateChangeListener(Function listener,
                                     Object instance)

Adds a listener to the data transfer service that is interested in its state change. The listners are notified in the order that they are added. A listener can cancel notification to other listeners in the chain by returning false.

Parameters:
listener  -  listener function to remove
instance  -  to pass as this when calling function
Return:
Object
Overrides:
AdfDataTransferService.addStateChangeListener(Function, Object)

getDTSState

public Object getDTSState()

Return the current DTS state. return (int) _state

Return:
Object
Overrides:
AdfDataTransferService.getDTSState()

notifyStreamingRequestComplete

public Object notifyStreamingRequestComplete()

Notifies Data Transfer Service that the streaming request is done

Return:
Object
Overrides:
AdfDataTransferService.notifyStreamingRequestComplete()

pageUnloading

public Object pageUnloading()

Return:
Object
Overrides:
AdfDataTransferService.pageUnloading()

processStreamingResponse

public Object processStreamingResponse(Object script)

Called by the script from within the streaming IFRAME

Parameters:
script  -  script to be executed in the context of the streaming IFRAME
Return:
Object
Overrides:
AdfDataTransferService.processStreamingResponse(Object)

removeStateChangeListener

public Object removeStateChangeListener(Function listener,
                                        Object instance)

Removes a listener from the data transfer service that is interested in its state change.

Parameters:
listener  -  listener function to remove
instance  -  to pass as this when calling function
Return:
Object
Overrides:
AdfDataTransferService.removeStateChangeListener(Function, Object)

resume

public Object resume()

Resumes the data transfer service, allowing normally processing to continue.

Return:
Object
Overrides:
AdfDataTransferService.resume()

sendMultiPartRequest

public Object sendMultiPartRequest(Object context,
                                   Object actionURL,
                                   Object htmlForm,
                                   Object params,
                                   Object listeners)

Performs Asynchronous HTTP Request with the Server for multipart data

Parameters:
context  -  any object that is sent back to the callback when the request is complete. This object can be null.
actionURL  -  this is the appropriate action url
htmlForm  -  the form containing multi-part data. The action attribute of the form is used for send the request to the server
params  -  additional parameters that need to be sent to the server
listeners  -  Objects that implements DataTransferRequestListener interface
Return:
Object
Overrides:
AdfDataTransferService.sendMultiPartRequest(Object, Object, Object, Object, Object, Object, Object)

sendPollingRequest

public Object sendPollingRequest(Object actionURL,
                                 Object listeners)

This function is only used for long-polling requests and interval polling requests. This method triggers a HTTP GET request to the server.

Parameters:
actionURL  -  the url to send the request to
listeners  -  Objects that implements DataTransferRequestListener interface
Return:
Object
Overrides:
AdfDataTransferService.sendPollingRequest(Object, Object)

sendRequest

public Object sendRequest(Object context,
                          Object actionURL,
                          Object headerParams,
                          Object content,
                          Object listeners)

Performs Asynchronous XML HTTP Request with the Server

Parameters:
context  -  any object that is sent back to the callback when the request is complete. This object can be null.
actionURL  -  the url to send the request to
headerParams  -  Option HTTP header parameters to attach to the request
content  -  the content of the Asynchronous XML HTTP Post
listeners  -  Objects that implements DataTransferRequestListener interface
Return:
Object
Overrides:
AdfDataTransferService.sendRequest(Object, Object, Object, Object, Object)

sendStreamingRequest

public Object sendStreamingRequest(Object actionURL,
                                   Object params)

Sends a streaming request to the server over an IFRAME

Parameters:
actionURL  -  the url to send the request to
params  -  additional request parameters
Return:
Object
Overrides:
AdfDataTransferService.sendStreamingRequest(Object, Object)

streamingResponsesOutstanding

public Boolean streamingResponsesOutstanding()

Return:
Boolean - Returns true if there are still outstanding streaming requests
Overrides:
AdfDataTransferService.streamingResponsesOutstanding()

suspend

public Object suspend()

Suspends the data transfer service until a matching call to resume() is made. While suspended, the data transfer service does not: - Send any new requests to the server - Transition between ready states. - Deliver state change events.

Return:
Object
Overrides:
AdfDataTransferService.suspend()

_warn

private Object _warn()

Return:
Object

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

 

Generated on 2014.03.27 12:59 UTC
Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.