Model (Oracle Fusion Middleware Java API Reference for Oracle Mobile Application Framework)

Object
- oracle.adfmf.framework.api.Model

```
public class Model
extends Object
```
Public services used by the UI framework to assist in the more common functions.

Constructor Summary

Constructors
Constructor and Description

Model()

Constructors
Constructor and Description
`Model()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBeanDefinition(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition def)` Add a bean definition to the current context.
`static void`	`addMonitorObservation(String monitorId, double duration)`
`static void`	`addMonitorObservation(String monitorId, String description, double duration)`
`static void`	`addMonitorObservations(JSONArray array)`
`static RestServiceAdapter`	`createRestServiceAdapter()` Get an empty REST service adapter object.
`static void`	`deviceIsReady()` Signals device is ready
`Object`	`evaluateMethodExpression(String expression, JSONArray params, String returnType, String[] paramTypes)` Evaluate the method expression passed in.
`String`	`fetchAmxPage(String page)` Return an amx file as a String from the given path.
`String`	`getContextId()` Get the current contextId / page def key.
`String`	`getContextInstanceId()` Deprecated. deprecated in 2.2.0.0.0, no longer needed.
`String`	`getContextPageDef()` Get the current context page definition
`String[]`	`getModelInventory()` Get the list of model's methods.
`oracle.adfmf.framework.contract.adf.NameValuePair[]`	`getValue(String[] variables)` Get a set of values from their passed in EL expressions.
`static void`	`loadBundle(AdfELContext context, String baseName, String variable)` Deprecated. deprecated in release 2.2.0.0.0, use `loadBundle(MafElContext, String, String)` instead.
`static void`	`loadBundle(oracle.adfmf.framework.model.MafElContext context, String baseName, String variable)` Load the given resource bundle
`void`	`loadBundle(String baseName, String variable)` Load the given resource bundle
`static Class`	`loadClassObj(String name)` Internal helper function to load classes in the current class loader.
`String`	`ping()` A simple ping test used to ensure the VM is up and functioning correctly.
`void`	`popPageFlowScope()` Pops a page flow and moves frame pointer down in the stack
`Object[]`	`processBatchRequests(Boolean abortOnError, JSONObject[] requests)` process the set of request as a batch.
`void`	`pushPageFlowScope()` Pushes a new page flow and creates a new frame pointer.
`void`	`removeBeanDefinition(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition def)` Remove a bean definition from the current context.
`void`	`removeContext(String contextKey, String instanceId)` Remove the context from the collection of contexts
`void`	`removeContextInstance(String contextKey, String instanceId)` Remove the context from the collection of contexts
`void`	`resetFeature()` Reset the current feature.
`void`	`setBeanDefinitions(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition[] defs)` Set the bean definitions into the current context - Clears all currently registered definitions.
`oracle.adfmf.bindings.dbf.AmxBindingContainer`	`setBindingContainer(String pagePath, boolean resetViewScope)` Set the current binding container and optionally re-set the viewScope.
`String[]`	`setContext(String contextKey)` Deprecated. deprecated in 2.2.1.0.0, use `setCurrentContext(java.lang.String,boolean,boolean,boolean)`instead.
`String[]`	`setContextInstance(String contextKey, String instanceId, boolean resetState, boolean reSync)` Deprecated. deprecated in 2.2.1.0.0, use `setCurrentContext(java.lang.String,boolean,boolean,boolean)`instead.
`void`	`setCurrentContext(String contextKey, boolean refreshBindings, boolean reSyncBindings, boolean newViewScope)` Set the current context.
`oracle.adfmf.framework.contract.adf.NameValuePair[]`	`setValue(oracle.adfmf.framework.contract.adf.NameValuePair[] data)` Set a set of EL values
`static void`	`waitForDeviceReady()` Wait for device is ready

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Model
```
public Model()
```
- Method Detail
  - loadClassObj
```
public static Class loadClassObj(String name)
                          throws ClassNotFoundException
```
    Internal helper function to load classes in the current class loader.
    
    Parameters:
    
    name - class name
    
    Returns:
    
    Class object
    
    Throws:
    
    ClassNotFoundException
  - ping
```
public String ping()
```
    A simple ping test used to ensure the VM is up and functioning correctly.
  - pushPageFlowScope
```
public void pushPageFlowScope()
```
    Pushes a new page flow and creates a new frame pointer.
  - popPageFlowScope
```
public void popPageFlowScope()
```
    Pops a page flow and moves frame pointer down in the stack
  - getModelInventory
```
public String[] getModelInventory()
```
    Get the list of model's methods. Used for introspecting purposes.
  - processBatchRequests
```
public Object[] processBatchRequests(Boolean abortOnError,
                                     JSONObject[] requests)
```
    process the set of request as a batch. We determine if we should stop processing (abort the batch) on error or not. Please note, that error really relates to catastrophic exceptions and not simply softer that the request simply failed to do an error.
    
    Parameters:
    
    abortOnError -
    
    requests -
    
    Returns:
    
    array of results (1-1 with the requests)
  - resetFeature
```
public void resetFeature()
                  throws AdfException
```
    Reset the current feature.
    
    Throws:
    
    AdfException
  - getValue
```
public oracle.adfmf.framework.contract.adf.NameValuePair[] getValue(String[] variables)
                                                             throws AdfException
```
    Get a set of values from their passed in EL expressions.
    
    Parameters:
    
    variables - an array of EL expressions
    
    Returns:
    
    an array of the EL values
    
    Throws:
    
    AdfException
  - setValue
```
public oracle.adfmf.framework.contract.adf.NameValuePair[] setValue(oracle.adfmf.framework.contract.adf.NameValuePair[] data)
                                                             throws AdfException
```
    Set a set of EL values
    
    Parameters:
    
    data - an array of NameValuePairs (EL expression, value)
    
    Returns:
    
    an array of NameValuePairs (EL expression, value)
    
    Throws:
    
    AdfException
  - evaluateMethodExpression
```
public Object evaluateMethodExpression(String expression,
                                       JSONArray params,
                                       String returnType,
                                       String[] paramTypes)
                                throws AdfException
```
    Evaluate the method expression passed in.
    
    Parameters:
    
    expression - method expression
    
    params - to the method
    
    returnType - of the method
    
    paramTypes - of the method
    
    Returns:
    
    the result of executing the method with the given parameters
    
    Throws:
    
    AdfException
  - getContextId
```
public String getContextId()
                    throws AdfException
```
    Get the current contextId / page def key.
    
    Throws:
    
    AdfException
  - getContextPageDef
```
public String getContextPageDef()
                         throws AdfException
```
    Get the current context page definition
    
    Throws:
    
    AdfException
  - getContextInstanceId
```
@Deprecated
public String getContextInstanceId()
                                        throws AdfException
```
    Deprecated. deprecated in 2.2.0.0.0, no longer needed.
    
    Get the current context instance id
    
    Throws:
    
    AdfException
  - removeContext
```
public void removeContext(String contextKey,
                          String instanceId)
                   throws AdfException
```
    Remove the context from the collection of contexts
    
    Throws:
    
    AdfException
  - removeContextInstance
```
public void removeContextInstance(String contextKey,
                                  String instanceId)
                           throws AdfException
```
    Remove the context from the collection of contexts
    
    Throws:
    
    AdfException
  - fetchAmxPage
```
public String fetchAmxPage(String page)
```
    Return an amx file as a String from the given path. Any include tags will be expanded and their referenced content inserted within the tag, and any referenced bindings will be brought into the parent binding container. Included bindings will have their identifiers prefixed with the include tag id
    
    Parameters:
    
    page - - the path to the page to load
  - setContext
```
public String[] setContext(String contextKey)
                    throws AdfException
```
    Deprecated. deprecated in 2.2.1.0.0, use setCurrentContext(java.lang.String,boolean,boolean,boolean)instead.
    
    Set the context.
    
    Throws:
    
    AdfException
  - setContextInstance
```
public String[] setContextInstance(String contextKey,
                                   String instanceId,
                                   boolean resetState,
                                   boolean reSync)
                            throws AdfException
```
    Deprecated. deprecated in 2.2.1.0.0, use setCurrentContext(java.lang.String,boolean,boolean,boolean)instead.
    
    Set the context
    
    Throws:
    
    AdfException
  - setCurrentContext
```
public void setCurrentContext(String contextKey,
                              boolean refreshBindings,
                              boolean reSyncBindings,
                              boolean newViewScope)
                       throws AdfException
```
    Set the current context.
    
    Parameters:
    
    contextKey - the key/ID of the new context. If the context has data bindings this will be the path found in the .cpx file.
    
    refreshBindings - true to refresh data bindings now, false for deferred refresh.
    
    reSyncBindings - true to generate a DataChangeEvent with th new context's binding definitions.
    
    newViewScope - should a new viewScope also be initialized, releasing the previous one?
    
    Throws:
    
    AdfException
  - setBindingContainer
```
public oracle.adfmf.bindings.dbf.AmxBindingContainer setBindingContainer(String pagePath,
                                                                         boolean resetViewScope)
                                                                  throws AdfException
```
    Set the current binding container and optionally re-set the viewScope. When a new binding contain er made current the existing binding container is released.
    
    Parameters:
    
    pagePath - the page path from the .cpx file. A null value will release the current binding container and set the current binding container to null.
    
    resetViewScope - should the viewScope also be cleared?
    
    Throws:
    
    AdfException
  - addBeanDefinition
```
public void addBeanDefinition(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition def)
```
    Add a bean definition to the current context.
  - removeBeanDefinition
```
public void removeBeanDefinition(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition def)
```
    Remove a bean definition from the current context. Note this only removes the ability to instantiate the defined bean in the future - if a bean instance has been instantiated in a scope already, it will remain resolvable. If callers wish to clear the instance they will need to do so explicitly through a setValue call.
  - setBeanDefinitions
```
public void setBeanDefinitions(oracle.adfmf.framework.contract.adf.ManagedBeanDefinition[] defs)
                        throws AdfException
```
    Set the bean definitions into the current context - Clears all currently registered definitions. Note that if a bean has been instantiated in a scope, clearing the definition will -not- destroy the bean instance.
    
    Throws:
    
    AdfException
  - loadBundle
```
public void loadBundle(String baseName,
                       String variable)
                throws AdfException
```
    Load the given resource bundle
    
    Parameters:
    
    baseName - of the resource bundle
    
    variable - of the resource bundle
    
    Throws:
    
    AdfException
  - loadBundle
```
@Deprecated
public static void loadBundle(AdfELContext context,
                                          String baseName,
                                          String variable)
                                   throws AdfException
```
    Deprecated. deprecated in release 2.2.0.0.0, use loadBundle(MafElContext, String, String) instead.
    
    Load the given resource bundle
    
    Parameters:
    
    context - EL context
    
    baseName - of the resource bundle
    
    variable - of the resource bundle
    
    Throws:
    
    AdfException
  - loadBundle
```
public static void loadBundle(oracle.adfmf.framework.model.MafElContext context,
                              String baseName,
                              String variable)
                       throws AdfException
```
    Load the given resource bundle
    
    Parameters:
    
    context - EL context
    
    baseName - of the resource bundle
    
    variable - of the resource bundle
    
    Throws:
    
    AdfException
  - createRestServiceAdapter
```
public static RestServiceAdapter createRestServiceAdapter()
```
    Get an empty REST service adapter object.
  - deviceIsReady
```
public static void deviceIsReady()
```
    Signals device is ready
  - waitForDeviceReady
```
public static void waitForDeviceReady()
```
    Wait for device is ready
    
    Throws:
    
    Exception - if timeout or interrupted
  - addMonitorObservations
```
public static void addMonitorObservations(JSONArray array)
```
  - addMonitorObservation
```
public static void addMonitorObservation(String monitorId,
                                         double duration)
```
  - addMonitorObservation
```
public static void addMonitorObservation(String monitorId,
                                         String description,
                                         double duration)
```

Class Model

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Model

Method Detail

loadClassObj

ping

pushPageFlowScope

popPageFlowScope

getModelInventory

processBatchRequests

resetFeature

getValue

setValue

evaluateMethodExpression

getContextId

getContextPageDef

getContextInstanceId

removeContext

removeContextInstance

fetchAmxPage

setContext

setContextInstance

setCurrentContext

setBindingContainer

addBeanDefinition

removeBeanDefinition

setBeanDefinitions

loadBundle

loadBundle

loadBundle

createRestServiceAdapter

deviceIsReady

waitForDeviceReady

addMonitorObservations

addMonitorObservation

addMonitorObservation