public enum ObjectScope extends java.lang.Enum<ObjectScope>
Enum Constant and Description |
---|
APP
There will only be one scope object for every OpenWGA application using this object
|
CALL
There will be one scope object for every web call (request/response)
|
FORM
There will be one scope object for every individual WebTML form.
|
PORTLET
There will be one scope object for every individual WebTML portlet.
|
PORTLETPATH
Like portlet scope, but the first portlet to create the object will also serve the same object to all subprojects down the portlet hierarchy
|
SERVER
There will only be one scope object for the whole server.
|
SESSION
There will be one scope object for every user session
|
TMLPAGE
One scope for every rendered WebTML page which will stay active after rendering for subsequent AJAX calls and WebSocket communication.
|
WEBSOCKET
There will be one scope object for every WebSocket connection to OpenWGA.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isApplicationEventReceiver() |
boolean |
isApplicationEventReceiver(Event.Scope scope) |
boolean |
needsWebsockets() |
void |
notifyScopeObjectStateChange(ScopeObjectRegistry.ScopeObject scopeObject,
WGA wga,
DesignResourceReference ref) |
ScopeObjectRegistry |
resolve(WGA wga,
DesignResourceReference ref) |
java.util.List<ApplicationEventReceiver> |
resolveApplicationEventReceivers(WGA wga,
java.lang.String dbKey,
Event event) |
static ObjectScope |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static ObjectScope[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ObjectScope SERVER
public static final ObjectScope APP
public static final ObjectScope SESSION
public static final ObjectScope TMLPAGE
public static final ObjectScope CALL
public static final ObjectScope PORTLET
public static final ObjectScope PORTLETPATH
public static final ObjectScope FORM
public static final ObjectScope WEBSOCKET
public static ObjectScope[] values()
for (ObjectScope c : ObjectScope.values()) System.out.println(c);
public static ObjectScope valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic ScopeObjectRegistry resolve(WGA wga, DesignResourceReference ref) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.util.List<ApplicationEventReceiver> resolveApplicationEventReceivers(WGA wga, java.lang.String dbKey, Event event) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean isApplicationEventReceiver(Event.Scope scope)
public boolean needsWebsockets()
public void notifyScopeObjectStateChange(ScopeObjectRegistry.ScopeObject scopeObject, WGA wga, DesignResourceReference ref) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean isApplicationEventReceiver()