Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

oracle.apps.fnd.applcore.common.biPrefs
Interface UserPreferences

All Known Implementing Classes:
UserPreferencesImpl

public interface UserPreferences


Field Summary
static java.lang.String ACCESSIBILITY_MODE
           
static java.lang.String ACTION
           
static java.lang.String ADDITIONAL_CUSTOMIZATION_LEVEL
           
static java.lang.String APPLICATION_ID
           
static java.lang.String APPLICATION_SHORT_NAME
           
static java.lang.String CLIENT_ENCODING
           
static java.lang.String CURRENCY
           
static java.lang.String DATE_FORMAT
           
static java.lang.String DECIMAL_SEPARATOR
           
static java.lang.String FROM_LDAP
           
static java.lang.String GLOBAL
           
static java.lang.String GROUPING_SEPARATOR
           
static java.lang.String HISTORY_OVERRIDE_USER_NAME
           
static java.lang.String IMPERSONATE
           
static java.lang.String INDUSTRY
           
static java.lang.String INDUSTRY_IN_TERRITORY
           
static java.lang.String LANGUAGE
           
static java.lang.String LAST_ACCESSED_TIME
           
static java.lang.String MODULE
           
static java.lang.String NLS_LANG
           
static java.lang.String NLS_LANGUAGE
           
static java.lang.String NLS_SORT
           
static java.lang.String PILLAR_NAME
           
static java.lang.String PRODUCT
           
static java.lang.String PRODUCT_FAMILY
           
static java.lang.String SESSION_COOKIE
           
static java.lang.String SESSION_ID
           
static java.lang.String SITE
           
static java.lang.String TERRITORY
           
static java.lang.String TIME_FORMAT
           
static java.lang.String TIMEZONE
           
static java.lang.String TRACE_LEVEL
           
static java.lang.String USER_GUID
           
static java.lang.String USER_NAME
           
 
Method Summary
 java.lang.String getCacheKey()
          This returns a cache key which is supposed to contain all necessary information to capture the last update by any pillar.
 java.util.HashMap<java.lang.String,java.lang.String> getSessionProperties()
          This returns the actual preferences fetched from a combination of LDAP plus pillar updates.
 void setSessionProperties(java.util.HashMap<java.lang.String,java.lang.String> sessionProperties)
           
 

Field Detail

ACCESSIBILITY_MODE

static final java.lang.String ACCESSIBILITY_MODE
See Also:
Constant Field Values

ADDITIONAL_CUSTOMIZATION_LEVEL

static final java.lang.String ADDITIONAL_CUSTOMIZATION_LEVEL
See Also:
Constant Field Values

APPLICATION_ID

static final java.lang.String APPLICATION_ID
See Also:
Constant Field Values

APPLICATION_SHORT_NAME

static final java.lang.String APPLICATION_SHORT_NAME
See Also:
Constant Field Values

CLIENT_ENCODING

static final java.lang.String CLIENT_ENCODING
See Also:
Constant Field Values

CURRENCY

static final java.lang.String CURRENCY
See Also:
Constant Field Values

DATE_FORMAT

static final java.lang.String DATE_FORMAT
See Also:
Constant Field Values

DECIMAL_SEPARATOR

static final java.lang.String DECIMAL_SEPARATOR
See Also:
Constant Field Values

GROUPING_SEPARATOR

static final java.lang.String GROUPING_SEPARATOR
See Also:
Constant Field Values

INDUSTRY

static final java.lang.String INDUSTRY
See Also:
Constant Field Values

INDUSTRY_IN_TERRITORY

static final java.lang.String INDUSTRY_IN_TERRITORY
See Also:
Constant Field Values

LANGUAGE

static final java.lang.String LANGUAGE
See Also:
Constant Field Values

NLS_LANG

static final java.lang.String NLS_LANG
See Also:
Constant Field Values

NLS_LANGUAGE

static final java.lang.String NLS_LANGUAGE
See Also:
Constant Field Values

NLS_SORT

static final java.lang.String NLS_SORT
See Also:
Constant Field Values

PRODUCT

static final java.lang.String PRODUCT
See Also:
Constant Field Values

PRODUCT_FAMILY

static final java.lang.String PRODUCT_FAMILY
See Also:
Constant Field Values

SESSION_ID

static final java.lang.String SESSION_ID
See Also:
Constant Field Values

SITE

static final java.lang.String SITE
See Also:
Constant Field Values

TERRITORY

static final java.lang.String TERRITORY
See Also:
Constant Field Values

TIME_FORMAT

static final java.lang.String TIME_FORMAT
See Also:
Constant Field Values

TIMEZONE

static final java.lang.String TIMEZONE
See Also:
Constant Field Values

TRACE_LEVEL

static final java.lang.String TRACE_LEVEL
See Also:
Constant Field Values

IMPERSONATE

static final java.lang.String IMPERSONATE
See Also:
Constant Field Values

USER_GUID

static final java.lang.String USER_GUID
See Also:
Constant Field Values

USER_NAME

static final java.lang.String USER_NAME
See Also:
Constant Field Values

GLOBAL

static final java.lang.String GLOBAL
See Also:
Constant Field Values

HISTORY_OVERRIDE_USER_NAME

static final java.lang.String HISTORY_OVERRIDE_USER_NAME
See Also:
Constant Field Values

MODULE

static final java.lang.String MODULE
See Also:
Constant Field Values

ACTION

static final java.lang.String ACTION
See Also:
Constant Field Values

PILLAR_NAME

static final java.lang.String PILLAR_NAME
See Also:
Constant Field Values

SESSION_COOKIE

static final java.lang.String SESSION_COOKIE
See Also:
Constant Field Values

LAST_ACCESSED_TIME

static final java.lang.String LAST_ACCESSED_TIME
See Also:
Constant Field Values

FROM_LDAP

static final java.lang.String FROM_LDAP
See Also:
Constant Field Values
Method Detail

getCacheKey

java.lang.String getCacheKey()
This returns a cache key which is supposed to contain all necessary information to capture the last update by any pillar. The intent is that BI can use this cache key to store the state of preferences (much like the ApplCore session cookie) and pass this key back to ApplCore APIs when querying for preferences again. This is required in order to avoid fetching preferences on every single call into BI as BI will need to implement this functionality as a filter. Currently it is expected that this key will consist of LastAccessPillar, LastAccessTime and LastAccessPillarSessionId. However in order to isolate BI from changes to these details, it is proposed that this be made an opaque entity which BI is only responsible for associating with BI session state. The cache key should not be too long. In particular, it needs to fit into an HTTP cookie, so length limits should be observed.


getSessionProperties

java.util.HashMap<java.lang.String,java.lang.String> getSessionProperties()
This returns the actual preferences fetched from a combination of LDAP plus pillar updates.


setSessionProperties

void setSessionProperties(java.util.HashMap<java.lang.String,java.lang.String> sessionProperties)

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.