Skip navigation links

com.essbase.eas.framework.server.application
Class DefaultScopeType

java.lang.Object
com.essbase.eas.framework.server.application.DefaultScopeType

All Implemented Interfaces:

ScopeType

public class DefaultScopeType

extends java.lang.Object

implements ScopeType

This class implements the ScopeType interface. Creates static, publicly accesible instances that represent the normal defined set of scope types supported by the framework: (1) configuration scope, (2) builder scope, (3) application scope, (4) session scope, (5) request scope, and (6) user scope. The constructors for this class are private or protected, preventing instantiation of a DefaultScopeType except through derived classes.

Since:

6.5.2

Version:

6.5.2, 10/01/02

Author:

Hank Cox, Painted Word

Field Summary

static ScopeType	APP_SCOPE the object representing application scope.
static ScopeType	BUILDER_SCOPE the object representing builder scope.
static ScopeType	CONFIG_SCOPE the object representing configuration scope.
static ScopeType	REQUEST_SCOPE the object representing request scope.
static ScopeType	SESSION_SCOPE the object representing session scope.
static ScopeType	USER_SCOPE the object representing user scope.

Constructor Summary

protected

DefaultScopeType(java.lang.String name) constructs a DefaultScopeType object with the requested name

Method Summary

boolean	equals(java.lang.Object obj) Compares the specified object with this DefaultScopeType for equality.
java.lang.String	getName() implementation of the ScopeType.getName() method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_SCOPE

public static final ScopeType CONFIG_SCOPE

the object representing configuration scope. Normally this would be used to store configuration settings during initialization.

BUILDER_SCOPE

public static final ScopeType BUILDER_SCOPE

the object representing builder scope. Normally, this would only be used while the framework is "building" the application.

APP_SCOPE

public static final ScopeType APP_SCOPE

the object representing application scope.

SESSION_SCOPE

public static final ScopeType SESSION_SCOPE

the object representing session scope. Normally this would be used for objects that need to be persistent while a single "session" exists.

REQUEST_SCOPE

public static final ScopeType REQUEST_SCOPE

the object representing request scope. This is for objects that can be discarded once the application has satisfied a request.

USER_SCOPE

public static final ScopeType USER_SCOPE

the object representing user scope. This is for objects that are persistent for a single user, across sessions and applications. Note: with the current architecture and servlet security restrictions, it is probably not possible to share information in this scope across applications.

Constructor Detail

DefaultScopeType

protected DefaultScopeType(java.lang.String name)
                    throws java.lang.IllegalArgumentException

constructs a DefaultScopeType object with the requested name

Parameters:

name - - the name for this scope type

Throws:

java.lang.IllegalArgumentException

Method Detail

getName

public final java.lang.String getName()

implementation of the ScopeType.getName() method.

Specified by:

getName in interface ScopeType

Returns:

a String representing the scope type of this object.

equals

public final boolean equals(java.lang.Object obj)

Compares the specified object with this DefaultScopeType for equality. To be considered equal, the specified object must not be null, must satisfy obj instanceof DefaultScopeType, and the results of calling getName() on the

Overrides:

equals in class java.lang.Object

Skip navigation links