|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IContentContext
Holds contextual information related to the current CM call in a loosely-structured manner. Contextual information is expressed via (ContextKey key, Object value ) pairs agreed upon by the client and low-level code. It's important that both the code setting the contextual information and the code using the contextual information agree upon the key and the type of object which may be present. Some well-known context keys are defined in com.bea.content.ContextKey
Method Summary | |
---|---|
IContentContext |
copy() Create a copy of this object. |
Object |
getParameter(ContextKey key) Retrieves the specified parameter value. |
boolean |
hasParameter(ContextKey key) Returns true if the specified parameter is set. |
Set<ContextKey> |
parameterKeySet() |
IContentContext |
removeParameter(ContextKey key) Remove the specified parameter, if it exists and is not mutable. |
IContentContext |
setParameter(ContextKey key, Serializable value) Stores the specified parameter key and value in the IContentContext object. |
Method Detail |
---|
IContentContext copy()
IContentContext setParameter(ContextKey key, Serializable value)
Immutable keys can only be set once -- an attempt to set an immutable key once it exists will fail.
key
- The parameter key. The key must be non-null.value
- The parameter value. A null parameter value has the same effect as removing the parameter.ContentListKeys
Object getParameter(ContextKey key)
key
- The key for the parameter value to retrieve.boolean hasParameter(ContextKey key)
key
- The parameter key. The key must be non-null.IContentContext removeParameter(ContextKey key)
key
- The parameter key. The key must be non-null.Set<ContextKey> parameterKeySet()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.