com.cisco.provisioning.cpe.api
Enum DeviceDetailsOption

java.lang.Object
  java.lang.Enum<DeviceDetailsOption>
      com.cisco.provisioning.cpe.api.DeviceDetailsOption

All Implemented Interfaces:

Serializable, Comparable<DeviceDetailsOption>

public enum DeviceDetailsOption
extends Enum<DeviceDetailsOption>

The DeviceDetailsOption class defines strings constants passed to IPDevice.getDetails(DeviceID, List) to control inclusion of optional results.

See Also:

IPDevice.getDetails(DeviceID, List)

Enum Constant Summary

INCLUDE_LEASE_INFO
Include DHCP lease info in both IPv4 and IPv6 in the result.

Method Summary

static DeviceDetailsOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceDetailsOption[]	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

INCLUDE_LEASE_INFO

public static final DeviceDetailsOption INCLUDE_LEASE_INFO

Include DHCP lease info in both IPv4 and IPv6 in the result.

DHCP lease information will be retreived from provisioning group DHCP server(s). If no DHCP server responds, an error condition is returned. If a DHCP server does respond, but there is no active lease, no lease information will be included in the result and there will be no error returned.

Method Detail

values

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

Returns:

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

valueOf

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