|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.wcps.conductor.services.ClientContext
public class ClientContext
The context in which the client action/api is performed.
Nested Class Summary | |
---|---|
static class |
ClientContext.Projection Defines the projection to use when making the call. |
Field Summary | |
---|---|
static java.lang.Integer |
DEFAULT_ITEMS_PER_PAGE Default page size. |
static java.lang.Integer |
DEFAULT_START_INDEX Default start index (for pagination) |
static java.lang.String |
PROPERTY_CLASS_CONTEXT The context property for client class contexts. |
static java.lang.String |
PROPERTY_ITEMS_PER_PAGE The context property for items per page (for pagination). |
static java.lang.String |
PROPERTY_LOCALE The context property for locale. |
static java.lang.String |
PROPERTY_LOG_ERRORS The context property for error logging. |
static java.lang.String |
PROPERTY_NAMESPACE The context property for namespace. |
static java.lang.String |
PROPERTY_PROJECTION The context property for projection. |
static java.lang.String |
PROPERTY_START_INDEX The context property for start index (for pagination). |
static java.lang.String |
PROPERTY_USERNAME The context property for username. |
Constructor Summary | |
---|---|
|
ClientContext() |
protected |
ClientContext(java.util.HashMap<java.lang.String,java.lang.Object> contextParams) Construct ClientContext based on the specified map of key/value pairs. |
|
ClientContext(java.util.Properties properties) Construct ClientContext based on the specified properties. |
|
ClientContext(java.lang.String namespace) Construct ClientContext for the specified namespace. |
Method Summary | |
---|---|
void |
addContextClasses(java.lang.Class<?>... classes) Add the specified array of context classes to the ClientContext. |
protected java.lang.Object |
clone() |
ClientContext |
copy() Copy the current client context. |
java.lang.Object |
getAttribute(java.lang.String name) Get a client context attribute by name |
java.lang.Object |
getAttribute(java.lang.String name, java.lang.Object defaultValue) Returns the context attribute by name. |
java.lang.Integer |
getItemsPerPage() Retrieve the page size. |
java.util.Locale |
getLocale() Returns the specified locale. |
boolean |
getLogErrorMessages() Returns whether error logging has been enabled. |
java.lang.String |
getNamespace() Returns the current namespace. |
ClientContext.Projection |
getProjection() Retrieve the specified projection. |
java.lang.Integer |
getStartIndex() Retrieve the start index. |
void |
setAttribute(java.lang.String name, java.lang.Object value) Sets a client context attribute. |
void |
setItemsPerPage(java.lang.Integer itemsPerPage) Sets the page size (for pagination). |
void |
setLocale(java.util.Locale locale) Sets the locale for localized metadata. |
void |
setLogErrorMessages(java.lang.Boolean b) Enables/Disables logging of error messages. |
void |
setNamespace(java.lang.String namespace) Sets the current namespace |
void |
setProjection(ClientContext.Projection projection) Sets the projection in the client context. |
void |
setStartIndex(java.lang.Integer startIndex) Sets the start index (for pagination). |
java.lang.String |
toString() Returns the string version of this client context. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROPERTY_NAMESPACE
public static final java.lang.String PROPERTY_LOCALE
public static final java.lang.String PROPERTY_START_INDEX
public static final java.lang.String PROPERTY_ITEMS_PER_PAGE
public static final java.lang.String PROPERTY_PROJECTION
public static final java.lang.String PROPERTY_USERNAME
public static final java.lang.String PROPERTY_CLASS_CONTEXT
public static final java.lang.String PROPERTY_LOG_ERRORS
public static final java.lang.Integer DEFAULT_START_INDEX
public static final java.lang.Integer DEFAULT_ITEMS_PER_PAGE
Constructor Detail |
---|
public ClientContext()
public ClientContext(java.lang.String namespace)
public ClientContext(java.util.Properties properties)
protected ClientContext(java.util.HashMap<java.lang.String,java.lang.Object> contextParams)
Method Detail |
---|
public void setAttribute(java.lang.String name, java.lang.Object value)
public java.lang.Object getAttribute(java.lang.String name, java.lang.Object defaultValue)
This method will first check the local instance map by name, and then look for a system property by that name. If both are null, defaultValue is returned.
If the specified attribute is not set, then the default value will be set in the context for future reference.
public java.lang.Object getAttribute(java.lang.String name)
public void setNamespace(java.lang.String namespace)
public java.lang.String getNamespace()
public void setStartIndex(java.lang.Integer startIndex)
public java.lang.Integer getStartIndex()
public java.lang.Integer getItemsPerPage()
public ClientContext.Projection getProjection()
public void setProjection(ClientContext.Projection projection)
public void setItemsPerPage(java.lang.Integer itemsPerPage)
public boolean getLogErrorMessages()
public void setLogErrorMessages(java.lang.Boolean b)
public void addContextClasses(java.lang.Class<?>... classes)
May be required to marshal/unmarshal complex java types that are returned as results of a scenario.
public void setLocale(java.util.Locale locale)
public java.util.Locale getLocale()
public ClientContext copy()
public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |