OracleJavaScript API Reference for Oracle ADF Faces

 

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

oracle.adfinternal.view.js.data.inputSearch
Class AdfSequencedSections

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.data.inputSearch.AdfSequencedSections

public class AdfSequencedSections
extends AdfObject
Used by InputSearch's peer. The class is to help manage asynchronicity of searchSection resource fetching to return the data in a sequence same as the array sequence.


Field Summary

private Object
_sectionalData

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public
AdfSequencedSections(Object searchSections)
Used by InputSearch's peer.

Method Summary

private static Boolean
_beforePrefilter(Object component, Object suggestions, Object isListComprehensive, Object options)
Callback before invoking the "filter" property.
private static Object
_defaultFetchComplete(Object response, Object options)
The callback on successful REST call completion
private static Object
_defaultFetchFailed(Object statusCode, Object response, Object options)
The callback on REST call failure
private Object
_fetchComplete(Object response, Object options)
The callback for fetch completion of all the searchSections
private Object
_fetchFailed(Object statusCode, Object response, Object options)
The failure callbcak for all the searchSections
private static Object
_fetchingSpecificSuggestionsComplete(Object response, Object options)
private static Object
_fetchingSpecificSuggestionsFailed(Object statusCode, Object response, Object options)
public static Object
fetchSection(Object inputSearch, Object searchSection, Object isPrefetch, Object options)
Fetch the searchSection instance.
public static Object
fetchSpecificSuggestions(Object inputSearch, Object values)
private static Object
_getDefaultOptions(Object inputSearch, Object searchSection, Object isPrefetch, Object options)
Gets the options for the REST call
private Object
_getIndexToStartNotify(Object fetchedIndex)
private Object
_getOptions(Object inputSearch, Object searchSection, Object index)
private static Object
_getPrefetchOptions(Object inputSearch, Object searchSection)
protected Object
Init(Object searchSections)
Initializes the instance.
protected static Object
InitClass()
private Object
_notify(Object fetchedIndex, Object inputSearch)
The method that invokes the __sequencedCallback method on the peer sequentially in the order of the searchSection array passed to the constructor.
private static Object
_parse(Object xhrResponse)
Parses the raw data after it's returned from the data service and returns the collection object Invoke from peer file too.
private Object
_popuplateNonUrlSections(Object inputSearch, Object masterSuggestions)
Popuplating data for searchSection which have "filter" attribute configured instead of "dataUrl"
private static Object
_prefetchComplete(Object response, Object options)
Callback only for non default searchSections on successful REST call completion
private static Object
_prefetchFailed(Object statusCode, Object response, Object options)
Callback only for non default searchSections on REST call failure
public static Array
prefilter(AdfRichInputSearch|AdfRichSearchSection component, Array collection)
Excute Array.filter like operation on the collection object passed.
private Object
_sendRequest(Object sectionalData)
public Object
sendRequests()
The method to be invoked by the peer to make REST calls to all the searchSections passed to the constructor.
private Object
_shouldNotify(Object fetchedIndex)
private static Object
_shouldProcessPrefetchRequests(Object inputSearch)
private static Object
_wrapSuggestion(Object suggestionItem, Object index)
private static Object
_wrapSuggestions(Object collection, Object keyAttribute)

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

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

Field Detail


_sectionalData

private Object _sectionalData

Constructor Detail


AdfSequencedSections

public AdfSequencedSections(Object searchSections)

Used by InputSearch's peer. The class is to help manage asynchronicity of searchSection resource fetching to return the data in a sequence same as the array sequence.

Parameters:
searchSections  

Method Detail


_beforePrefilter

private static Boolean _beforePrefilter(Object component,
                                        Object suggestions,
                                        Object isListComprehensive,
                                        Object options)

Callback before invoking the "filter" property.

Parameters:
component  
suggestions  
isListComprehensive  
options  
Return:
Boolean - true to prefilter, false otherwise

_defaultFetchComplete

private static Object _defaultFetchComplete(Object response,
                                            Object options)

The callback on successful REST call completion

Parameters:
response  
options  
Return:
Object

_defaultFetchFailed

private static Object _defaultFetchFailed(Object statusCode,
                                          Object response,
                                          Object options)

The callback on REST call failure

Parameters:
statusCode  
response  
options  
Return:
Object

_fetchComplete

private Object _fetchComplete(Object response,
                              Object options)

The callback for fetch completion of all the searchSections

Parameters:
response  
options  
Return:
Object

_fetchFailed

private Object _fetchFailed(Object statusCode,
                            Object response,
                            Object options)

The failure callbcak for all the searchSections

Parameters:
statusCode  
response  
options  
Return:
Object

_fetchingSpecificSuggestionsComplete

private static Object _fetchingSpecificSuggestionsComplete(Object response,
                                                           Object options)

Parameters:
response  
options  
Return:
Object

_fetchingSpecificSuggestionsFailed

private static Object _fetchingSpecificSuggestionsFailed(Object statusCode,
                                                         Object response,
                                                         Object options)

Parameters:
statusCode  
response  
options  
Return:
Object

fetchSection

public static Object fetchSection(Object inputSearch,
                                  Object searchSection,
                                  Object isPrefetch,
                                  Object options)

Fetch the searchSection instance. options property passed is will be used while making the REST call and will be returned back the peer

Parameters:
inputSearch  
searchSection  
isPrefetch  
options  
Return:
Object

fetchSpecificSuggestions

public static Object fetchSpecificSuggestions(Object inputSearch,
                                              Object values)

Parameters:
inputSearch  
values  
Return:
Object

_getDefaultOptions

private static Object _getDefaultOptions(Object inputSearch,
                                         Object searchSection,
                                         Object isPrefetch,
                                         Object options)

Gets the options for the REST call

Parameters:
inputSearch  
searchSection  
isPrefetch  
options  
Return:
Object

_getIndexToStartNotify

private Object _getIndexToStartNotify(Object fetchedIndex)

Parameters:
fetchedIndex  
Return:
Object

_getOptions

private Object _getOptions(Object inputSearch,
                           Object searchSection,
                           Object index)

Parameters:
inputSearch  
searchSection  
index  
Return:
Object

_getPrefetchOptions

private static Object _getPrefetchOptions(Object inputSearch,
                                          Object searchSection)

Parameters:
inputSearch  
searchSection  
Return:
Object

Init

protected Object Init(Object searchSections)

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

Parameters:
searchSections  
Return:
Object
Overrides:
AdfObject.Init()

InitClass

protected static Object InitClass()

Return:
Object

_notify

private Object _notify(Object fetchedIndex,
                       Object inputSearch)

The method that invokes the __sequencedCallback method on the peer sequentially in the order of the searchSection array passed to the constructor.

Parameters:
fetchedIndex  
inputSearch  
Return:
Object

_parse

private static Object _parse(Object xhrResponse)

Parses the raw data after it's returned from the data service and returns the collection object Invoke from peer file too.

Parameters:
xhrResponse  
Return:
Object - Object with two properties a) items b) hasMore

_popuplateNonUrlSections

private Object _popuplateNonUrlSections(Object inputSearch,
                                        Object masterSuggestions)

Popuplating data for searchSection which have "filter" attribute configured instead of "dataUrl"

Parameters:
inputSearch  
masterSuggestions  
Return:
Object

_prefetchComplete

private static Object _prefetchComplete(Object response,
                                        Object options)

Callback only for non default searchSections on successful REST call completion

Parameters:
response  
options  
Return:
Object

_prefetchFailed

private static Object _prefetchFailed(Object statusCode,
                                      Object response,
                                      Object options)

Callback only for non default searchSections on REST call failure

Parameters:
statusCode  
response  
options  
Return:
Object

prefilter

public static Array prefilter(AdfRichInputSearch|AdfRichSearchSection component,
                              Array collection)

Excute Array.filter like operation on the collection object passed. The callback function name for Array.filter operation is available in component's "filter" property.

Parameters:
component  
collection - of suggestion items to filter
Return:
Array - the filtered collection

_sendRequest

private Object _sendRequest(Object sectionalData)

Parameters:
sectionalData  
Return:
Object

sendRequests

public Object sendRequests()

The method to be invoked by the peer to make REST calls to all the searchSections passed to the constructor.

Return:
Object

_shouldNotify

private Object _shouldNotify(Object fetchedIndex)

Parameters:
fetchedIndex  
Return:
Object

_shouldProcessPrefetchRequests

private static Object _shouldProcessPrefetchRequests(Object inputSearch)

Parameters:
inputSearch  
Return:
Object

_wrapSuggestion

private static Object _wrapSuggestion(Object suggestionItem,
                                      Object index)

Parameters:
suggestionItem  
index  
Return:
Object

_wrapSuggestions

private static Object _wrapSuggestions(Object collection,
                                       Object keyAttribute)

Parameters:
collection  
keyAttribute  
Return:
Object

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

 

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.