com.jamasoftware.contour.util.domain

Enum ScopeRefMode

java.lang.Object

java.lang.Enum<ScopeRefMode>

com.jamasoftware.contour.util.domain.ScopeRefMode

All Implemented Interfaces:

Serializable, Comparable<ScopeRefMode>

public enum ScopeRefMode
extends Enum<ScopeRefMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTEXT_SCOPE_REF
DIFF_VIEW_FROM
DIFF_VIEW_TO
SCOPE_REF

Method Summary

Methods

Modifier and Type	Method and Description
abstract Integer	getRefIdFrom(DomainObjectBase obj)
abstract String	getRefIdPropertyName()
abstract Integer	getScopeIdFrom(DomainObjectBase obj)
abstract String	getScopePropertyName()
abstract void	setRefIdOn(DomainObjectBase obj, Integer refId)
abstract void	setScopeIdOn(DomainObjectBase obj, Integer scopeId)
static ScopeRefMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScopeRefMode[]	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

SCOPE_REF

public static final ScopeRefMode SCOPE_REF

CONTEXT_SCOPE_REF

public static final ScopeRefMode CONTEXT_SCOPE_REF

DIFF_VIEW_FROM

public static final ScopeRefMode DIFF_VIEW_FROM

DIFF_VIEW_TO

public static final ScopeRefMode DIFF_VIEW_TO

Method Detail

values

public static ScopeRefMode[] 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 (ScopeRefMode c : ScopeRefMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScopeRefMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getScopeIdFrom

public abstract Integer getScopeIdFrom(DomainObjectBase obj)

getRefIdFrom

public abstract Integer getRefIdFrom(DomainObjectBase obj)

setScopeIdOn

public abstract void setScopeIdOn(DomainObjectBase obj,
                Integer scopeId)

setRefIdOn

public abstract void setRefIdOn(DomainObjectBase obj,
              Integer refId)

getScopePropertyName

public abstract String getScopePropertyName()

getRefIdPropertyName

public abstract String getRefIdPropertyName()