com.flexive.shared.configuration
Enum ParameterScope

java.lang.Object
  extended by java.lang.Enum<ParameterScope>
      extended by com.flexive.shared.configuration.ParameterScope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ParameterScope>

public enum ParameterScope
extends java.lang.Enum<ParameterScope>

Parameter scopes


Enum Constant Summary
APPLICATION
          Application parameter scope (with division configuration fallback).
APPLICATION_ONLY
          Application parameter scope (without division configuration fallback).
DIVISION
          Division parameter (with global configuration fallback)
DIVISION_ONLY
          Division parameter (without global configuration fallback)
GLOBAL
          Global parameter
MANDATOR
          Mandator parameter scope (with division configuration fallback).
MANDATOR_ONLY
          Mandator parameter scope (without fallback).
NODE
          Node parameter (with division configuration fallback).
NODE_ONLY
          Node parameter (without fallback).
USER
          User parameter (with application configuration fallback)
USER_ONLY
          User parameter (without fallback values)
 
Method Summary
 java.util.List<ParameterScope> getFallbacks()
          Return the fallback scopes for this scope config.
 boolean hasScope(ParameterScope scope)
          Returns true if the scope represents - directly or through its fallbacks - the given scope.
static ParameterScope valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ParameterScope[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

GLOBAL

public static final ParameterScope GLOBAL
Global parameter


DIVISION

public static final ParameterScope DIVISION
Division parameter (with global configuration fallback)


DIVISION_ONLY

public static final ParameterScope DIVISION_ONLY
Division parameter (without global configuration fallback)


NODE

public static final ParameterScope NODE
Node parameter (with division configuration fallback). The node name can be set with the system property flexive.nodename and defaults to the system hostname as returned by InetAddress.getLocalHost().getHostName().

Since:
3.1

NODE_ONLY

public static final ParameterScope NODE_ONLY
Node parameter (without fallback).


APPLICATION

public static final ParameterScope APPLICATION
Application parameter scope (with division configuration fallback). The division fallback does not include the global configuration, because this configuration is outside the scope of a running fleXive application and cannot be updated by a flexive user without using the authentication methods provided by the GlobalConfigurationEngine.

Since:
3.1

APPLICATION_ONLY

public static final ParameterScope APPLICATION_ONLY
Application parameter scope (without division configuration fallback).


MANDATOR

public static final ParameterScope MANDATOR
Mandator parameter scope (with division configuration fallback).

Since:
3.1.6

MANDATOR_ONLY

public static final ParameterScope MANDATOR_ONLY
Mandator parameter scope (without fallback).

Since:
3.1.6

USER

public static final ParameterScope USER
User parameter (with application configuration fallback)


USER_ONLY

public static final ParameterScope USER_ONLY
User parameter (without fallback values)

Method Detail

values

public static ParameterScope[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ParameterScope c : ParameterScope.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParameterScope valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getFallbacks

public java.util.List<ParameterScope> getFallbacks()
Return the fallback scopes for this scope config.

Returns:
the fallback scopes for this scope config.

hasScope

public boolean hasScope(ParameterScope scope)
Returns true if the scope represents - directly or through its fallbacks - the given scope.

Parameters:
scope - the scope to be checked
Returns:
true if the scope represents - directly or through its fallbacks - the given scope.