oracle.adf.share
Interface ADFScope

All Superinterfaces:

java.util.Map

All Known Implementing Classes:

HashMapScopeAdapter, HttpServletRequestScopeAdapter, HttpSessionScopeAdapter, ServletContextScopeAdapter

public interface ADFScope
extends java.util.Map

Since:

release specific (what release of product did this appear in)

Defines an interface for ADFScopes.

This interface defines scope operations that are not supported by the base Map scope interface. These operations include: Scope invalidation, scope lifecycle notifications.

A scope user may invalidate a scope by invoking the invalidate() operation on this interface. After an ADFScope is invalidated the scope's state will be unreachable and all cached references to the invalid ADFScope must be nulled. If a scope is used after it is invalidated it may throw a RuntimeException (InvalidStateException).

A scope client may be notified of invalidation events by using the addScopeListener(ADFScopeListener) to register an invalidation listener.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

void	addScopeListener(ADFScopeListener listener)
void	invalidate()
java.lang.Object	putTransient(java.lang.Object key, java.lang.Object value) If the scope supports failover then this may be used to notify the scope that the state does not require failover.
void	removeScopeListener(ADFScopeListener listener)

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

putTransient

java.lang.Object putTransient(java.lang.Object key,
                              java.lang.Object value)

If the scope supports failover then this may be used to notify the scope that the state does not require failover.

invalidate

void invalidate()

addScopeListener

void addScopeListener(ADFScopeListener listener)

removeScopeListener

void removeScopeListener(ADFScopeListener listener)