|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchContext
SearchContext
is a runtime container for contextual information
for applications search. It contains search related meta information.
It also holds a reference to an external context that might be useful for the purpose of search as well as security etc.
For example, when used for searching, it holds a reference to AppsWebContext and can be obtained by getAppsContext.
This context is passed to most applications plug-in code where custom implemenation can obtain runtime context information.
Field Summary | |
---|---|
static java.lang.String |
ACL_KEY
Access control list key value |
static java.lang.String |
ECSF_IS_ADMIN_MODE
|
static java.lang.String |
GLOBAL
|
static java.lang.String |
LOCAL
|
Method Summary | |
---|---|
void |
bindProxySession(java.lang.Object sessionObj)
Deprecated. Binds search engine proxy session to this context. |
void |
bindUser(java.lang.String userName)
Binds user name of undeline user session |
ApplicationExtension |
getApplicationExtension()
Returns application extension if exists, otherwise, null is returned. |
java.lang.Object |
getAttribute(java.lang.Object key)
Returns a hashed object; |
java.util.Map |
getAttributes()
Returns attributes assigned to the context. |
java.sql.Connection |
getConnection()
Provides cross module service for connection management. |
java.util.Locale |
getCurrLocale()
Returns locale of current session user. |
long |
getEngineInstanceId()
Return engine instance id assigned to the context; |
java.lang.String |
getErrorMessage()
Returns the error message for this search |
java.lang.Object |
getExternalContext()
Returns Application Context assigned to this search context. |
java.lang.Object |
getProxySession()
Deprecated. Returns search engine proxy session object. |
java.lang.String |
getScope()
Returns the search scope associated with this context. |
SearchableObject |
getSearchableObject()
Returns the searchable object associated with this context. |
java.lang.Object |
getSessionObject()
Returns session bound to this context. |
java.lang.String |
getUserName()
Returns user name of the user bound to this context. |
java.io.Writer |
getWriter()
Returns a writer to write information to external systems. |
boolean |
isError()
Returns the error status for the search |
void |
release()
Releases the context, and clean up resources used by this context. |
void |
releaseConnection()
Provides cross module service for connection management. |
void |
setAttribute(java.lang.Object key,
java.lang.Object value)
Sets a hash value for the given key. |
void |
setCurrLocale(java.util.Locale locale)
Sets locale associated with this context. |
void |
setEngineInstanceId(long engineInstanceId)
Associates an engineInstanceId with this context. |
void |
setError(boolean error)
Flags that the search resulted in error |
void |
setErrorMessage(java.lang.String errorMessage)
Sets the error message for this search, used by the searcher. |
void |
setExternalContext(java.lang.Object ctx)
Sets external context. |
void |
setLoggingContext(ECSFLoggingContext ctx)
Sets the logging context for the current search context. |
void |
setScope(java.lang.String scope)
Sets the search scope associated with this context. |
void |
setSearchableObject(SearchableObject searchableObject)
Associates a searhable object with this context. |
void |
setSessionObject(java.lang.Object sessionObject)
Binds the context to a session. |
void |
setUserName(java.lang.String username)
Sets username without binding. |
void |
setWriter(java.io.Writer writer)
Assigns a writer to this context. |
Field Detail |
---|
static final java.lang.String GLOBAL
static final java.lang.String LOCAL
static final java.lang.String ECSF_IS_ADMIN_MODE
static final java.lang.String ACL_KEY
Method Detail |
---|
java.lang.Object getAttribute(java.lang.Object key)
void setAttribute(java.lang.Object key, java.lang.Object value)
key
- hash key.value
- hash value.java.io.Writer getWriter()
void setWriter(java.io.Writer writer)
writer
- java.lang.Object getExternalContext()
From an application context, User security context, locale etc can be objtained.
void setExternalContext(java.lang.Object ctx)
For Oracle Applications, oracle.apps.fnd.common.WebAppsContext.
ctx
- external context to be set.java.lang.Object getSessionObject()
void setSessionObject(java.lang.Object sessionObject)
sessionObject
- void bindProxySession(java.lang.Object sessionObj)
sessionObj
- session object.java.lang.Object getProxySession()
SearchableObject getSearchableObject()
void setSearchableObject(SearchableObject searchableObject)
Every context can only be associated with one searchable object at a time.
searchableObject
- to be associated with this context.void setEngineInstanceId(long engineInstanceId)
engineInstanceId
- to be associated with this context.long getEngineInstanceId()
void release()
void setLoggingContext(ECSFLoggingContext ctx)
ctx
- ECSF logging contextjava.sql.Connection getConnection()
void releaseConnection()
java.util.Locale getCurrLocale()
void setCurrLocale(java.util.Locale locale)
locale
- the locale to be set.java.lang.String getUserName()
void setUserName(java.lang.String username)
username
- to be associated with the context.void bindUser(java.lang.String userName)
java.util.Map getAttributes()
java.lang.String getScope()
void setScope(java.lang.String scope)
scope
- the scopeApplicationExtension getApplicationExtension()
void setError(boolean error)
error
- boolean isError()
void setErrorMessage(java.lang.String errorMessage)
errorMessage
- java.lang.String getErrorMessage()
|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |