public interface UserWorkArea
extends java.io.Serializable
| Modifier and Type | Method and Description |
|---|---|
void |
begin(java.lang.String name)
Begin a new WorkArea associated with it the current thread.
|
void |
complete()
Will complete the current, active WorkArea and will lose the references
to any contained context.
|
java.io.Serializable |
get(java.lang.String key)
The get operation will search the current WorkArea for a corresponding
property.
|
PropertyModeType |
getMode(java.lang.String key)
The getMode operation will search the current WorkArea for a corresponding
property's mode.
|
java.lang.String |
getName()
Returns the context's name.
|
void |
remove(java.lang.String key)
Removes property from current WorkArea scope.
|
java.lang.String[] |
retrieveAllKeys()
Returns an array of all keys associated with the stack of WorkAreas for the
current thread.
|
void |
set(java.lang.String key,
java.io.Serializable value)
Set the specified property.
|
void |
set(java.lang.String key,
java.io.Serializable value,
PropertyModeType mode)
Sets given property by mode.
|
void begin(java.lang.String name)
name - The name that will be associated with this WorkArea. Note
that the WorkArea service attaches no meaning to this name;
it is instead to be used by the application as desired. The
WorkArea service requires only that the name not be null.java.lang.NullPointerException - Thrown if the name reference is null.void complete()
throws NoWorkArea,
NotOriginator
NoWorkArea - Thrown if there is no active WorkArea associated with
the current thread.NotOriginator - Thrown if the WorkArea was imported from another process.java.lang.String getName()
java.lang.String[] retrieveAllKeys()
void set(java.lang.String key,
java.io.Serializable value)
throws NoWorkArea,
NotOriginator,
PropertyReadOnly
key - May not be null.value - May not be null.NoWorkArea - Thrown if there is no active WorkArea associated with the thread.NotOriginator - Thrown if the active WorkArea was imported from another process.PropertyReadOnly - Thrown if the corresponding property was set as read_only.java.lang.NullPointerException - Thrown if the key is null.void set(java.lang.String key,
java.io.Serializable value,
PropertyModeType mode)
throws NoWorkArea,
NotOriginator,
PropertyReadOnly
key - May not be null.value - May not be null.mode - May not be null.NoWorkArea - Thrown if there is no active WorkArea associated with the thread.NotOriginator - Thrown if the active WorkArea was imported from another process.PropertyReadOnly - Thrown if the corresponding property was set as read_only.java.lang.NullPointerException - Thrown if the key or mode is null.java.io.Serializable get(java.lang.String key)
key - The key to search by. May not be null.NotSerializableError - Thrown if the corresponding is not serializable (i.e., was set via a CORBA interface)java.lang.NullPointerException - Thrown if the key is null.PropertyModeType getMode(java.lang.String key)
key - The key to search by. May not be null.java.lang.NullPointerException - Thrown if the key is null.void remove(java.lang.String key)
throws NoWorkArea,
NotOriginator,
PropertyFixed
key - May not be null.NoWorkArea - Thrown if there is no active WorkArea associated with the thread.NotOriginator - Thrown if the operation is invoked against a WorkArea imported from another process.PropertyFixed - Thrown if the property was set as fixed.java.lang.NullPointerException - Thrown if the key is null.