org.eclipse.osbp.runtime.common.state

Interface ISharedStateContext

All Known Implementing Classes:

SharedStateContext

public interface ISharedStateContext

Different participants may share data.

For instance an IDataState. In a business application groups of views may share the same data like beans. And other groups of views will share their own data. A shared environment is an abstraction above this group. Views may share the ISharedStateContext and will also share their properties and data.

Method Summary

Modifier and Type	Method and Description
void	addNewTransient(Object newEntry) Adds a new "not persistent" entry.
IDataState	getDirtyAwareGlobalState() Returns an immutable compound state that handles the global and dirty state.
IDataState	getDirtyState() Returns the dirty state that contains all dirty objects for the shared state.
IDataState	getGlobalDataState() Returns the "used state" that contains all objects that are currently used for the shared state.
String	getId() Returns the unique id of the environment.
Object	getProperty(Object key) Returns the value for the key or null if no value registered.
Object[]	getPropertyKeys() Returns all keys that are registered in the environment.
void	makeUndirty(Object key, Object dto) Makes the given dto undirty.
void	setProperty(Object key, Object value) Set and key value pair to be shared in the environment.

Method Detail

getId

String getId()

Returns the unique id of the environment.

Returns:

the id

setProperty

void setProperty(Object key,
                 Object value)

Set and key value pair to be shared in the environment.

Parameters:

key - the key

value - the value

getProperty

Object getProperty(Object key)

Returns the value for the key or null if no value registered.

Parameters:

key - the key

Returns:

the property

getPropertyKeys

Object[] getPropertyKeys()

Returns all keys that are registered in the environment.

Returns:

the property keys

getDirtyState

IDataState getDirtyState()

Returns the dirty state that contains all dirty objects for the shared state.

Returns:

the dirty state

getGlobalDataState

IDataState getGlobalDataState()

Returns the "used state" that contains all objects that are currently used for the shared state.

Returns:

the global data state

getDirtyAwareGlobalState

IDataState getDirtyAwareGlobalState()

Returns an immutable compound state that handles the global and dirty state.

Returns:

the dirty aware global state

makeUndirty

void makeUndirty(Object key,
                 Object dto)

Makes the given dto undirty.

Parameters:

key - the key

dto - the dto

addNewTransient

void addNewTransient(Object newEntry)

Adds a new "not persistent" entry. The key will be calculated using the HashUtil.

The object will be put into the dirtyState but not the global state.

Parameters:

newEntry - the new entry