com.cisco.provisioning.cpe.api.search
Enum ReturnParameters

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

All Implemented Interfaces:

Serializable, Comparable<ReturnParameters>

public enum ReturnParameters
extends Enum<ReturnParameters>

This enum ReturnParameters is used mainly in DeviceSearchType and NodeSearchType to indicate what parameter should be included in the result set for the devices search or nodes search.

Enum Constant Summary

ALL
Get all parameters for the matching devices or nodes.

BASIC
When this flag is used in DeviceSearchType without specifying the DeviceIDPattern parameter, the result will be primary key which is the DeviceOid When this flag is used in DeviceSearchType function with the DeviceIDPattern, the result is the Key which is the DeviceID subclasses correspond to the specified DeviceIDPattern.

Method Summary

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

ALL

public static final ReturnParameters ALL

Get all parameters for the matching devices or nodes.

When this flag is used in DeviceSearchType to search devices, the data coming back for matching devices are: primary key which is DeviceOid, Key which is DeviceID and the device properties Map but with out leases info.

When this flag is use in NodeSearchType to search for Node, the data coming back for matching Node are: Key which is Node and the node properties Map.

See Also:

RecordSearchResults, RecordData

BASIC

public static final ReturnParameters BASIC

When this flag is used in DeviceSearchType without specifying the DeviceIDPattern parameter, the result will be primary key which is the DeviceOid

When this flag is used in DeviceSearchType function with the DeviceIDPattern, the result is the Key which is the DeviceID subclasses correspond to the specified DeviceIDPattern.

Method Detail

values

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

Returns:

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

valueOf

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