Package de.elo.ix.client.subs

Enum Class SubstitutionStatus

java.lang.Object

java.lang.Enum<SubstitutionStatus>

de.elo.ix.client.subs.SubstitutionStatus

All Implemented Interfaces:

Serializable, Comparable<SubstitutionStatus>, Constable

public enum SubstitutionStatus
extends Enum<SubstitutionStatus>

The substitution status is used to inform if a substitution is currently deactivated or activated. If activated, it also informs how it was activated (either by a SubstitutionPeriod or manually)

Since:

12.00.000.001

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVATED_BY_PERIOD	A substitution which is currently active and is active because it is within a defined SubstitutionPeriod
ACTIVATED_MANUALLY	A substitution which is currently active and is active because it was activated manually by calling IXServicePortIF.activateSubstitution(de.elo.ix.client.ClientInfo, java.lang.String, de.elo.ix.client.LockZ)()
DEACTIVATED	A substitution which is currently not active.

Method Summary

Modifier and Type	Method	Description
static SubstitutionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SubstitutionStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEACTIVATED

public static final SubstitutionStatus DEACTIVATED

A substitution which is currently not active.

ACTIVATED_BY_PERIOD

public static final SubstitutionStatus ACTIVATED_BY_PERIOD

A substitution which is currently active and is active because it is within a defined SubstitutionPeriod

ACTIVATED_MANUALLY

public static final SubstitutionStatus ACTIVATED_MANUALLY

A substitution which is currently active and is active because it was activated manually by calling IXServicePortIF.activateSubstitution(de.elo.ix.client.ClientInfo, java.lang.String, de.elo.ix.client.LockZ)()

Method Details

values

public static SubstitutionStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SubstitutionStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null