com.cisco.provisioning.cpe.extensions.configuration
Enum ServiceLevelReason

java.lang.Object
  extended by java.lang.Enum<ServiceLevelReason>
      extended by com.cisco.provisioning.cpe.extensions.configuration.ServiceLevelReason
All Implemented Interfaces:
Serializable, Comparable<ServiceLevelReason>

public enum ServiceLevelReason
extends Enum<ServiceLevelReason>

Enumerated type for specifying the reason why the service level selection extension granted the type of access.

The user-friendly text associated with each reason is used in UI and in logging where it is used to form a larger sentence. Hence, it is important that the the text start with "because".


Enum Constant Summary
NOT_BEHIND_REQUIRED_DEVICE
          The device is not behind its required relay agent.
NOT_IN_REQUIRED_PROV_GROUP
          The device is not in its required provisioning group.
NOT_REGISTERED
          The device is not registered.
OTHER
          The device was granted access for some non-standard reason.
PROMISCUOUS_ACCESS_ENABLED
          Promiscuous access was enabled for the relay agent.
REGISTERED
          The device was registered and met any requirements for access.
RELAY_NOT_IN_REQUIRED_PROV_GROUP
          The relay agent was not in its required provisioning group.
RELAY_NOT_REGISTERED
          The relay agent was not registered.
RESERVED_0
          Reserved for future use.
 
Method Summary
 String getDisplayString()
           
 String getDisplayStringLowerCase()
           
static ServiceLevelReason valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ServiceLevelReason[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

RESERVED_0

public static final ServiceLevelReason RESERVED_0
Reserved for future use.


NOT_BEHIND_REQUIRED_DEVICE

public static final ServiceLevelReason NOT_BEHIND_REQUIRED_DEVICE
The device is not behind its required relay agent.


NOT_IN_REQUIRED_PROV_GROUP

public static final ServiceLevelReason NOT_IN_REQUIRED_PROV_GROUP
The device is not in its required provisioning group.


NOT_REGISTERED

public static final ServiceLevelReason NOT_REGISTERED
The device is not registered.


OTHER

public static final ServiceLevelReason OTHER
The device was granted access for some non-standard reason. This can be used by custom service level selection extensions that have their own reasons for granting access.


PROMISCUOUS_ACCESS_ENABLED

public static final ServiceLevelReason PROMISCUOUS_ACCESS_ENABLED
Promiscuous access was enabled for the relay agent.


REGISTERED

public static final ServiceLevelReason REGISTERED
The device was registered and met any requirements for access.


RELAY_NOT_IN_REQUIRED_PROV_GROUP

public static final ServiceLevelReason RELAY_NOT_IN_REQUIRED_PROV_GROUP
The relay agent was not in its required provisioning group.


RELAY_NOT_REGISTERED

public static final ServiceLevelReason RELAY_NOT_REGISTERED
The relay agent was not registered.

Method Detail

values

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

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

valueOf

public static ServiceLevelReason 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

getDisplayString

public String getDisplayString()
Returns:
user-friendly constant description

getDisplayStringLowerCase

public String getDisplayStringLowerCase()
Returns:
user-friendly constant description in lower-case