com.cisco.provisioning.cpe
Class ConfirmationMode

java.lang.Object
  com.cisco.provisioning.cpe.internal.BaseEnum
      com.cisco.provisioning.cpe.ConfirmationMode

All Implemented Interfaces:

Externalizable, Serializable, Comparable

public final class ConfirmationMode
extends com.cisco.provisioning.cpe.internal.BaseEnum
implements Externalizable

The ConfirmationMode class provides an enumeration of batch confirmation request states that are set on a Batch TODO: Obsolete. It already did nothing. explain that it is a No-OP and obsoleted i.e. will be removed in the next release

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

com.cisco.provisioning.cpe.internal.BaseEnum.CompareDifferentClassEnumException

Field Summary

static ConfirmationMode	CUSTOM_CONFIRMATION This mode is currently ignored by the RDU and is equivalent to ConfirmationMode.NO_CONFIRMATION.
static ConfirmationMode	NO_CONFIRMATION This mode specifies the RDU will allow the batch to proceed, even if there is an error or warning during device disruption.

Fields inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

NAME, VALUE

Constructor Summary

ConfirmationMode()
Default constructor needed for externalization.

Method Summary

static ConfirmationMode	getNamed(String name) Returns the ConfirmationMode object with the selected name (or null if it does not exist).
static SortedSet	getSortedSet() Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.
static ConfirmationMode	getValued(int value) Returns the ConfirmationMode object with the selected value (or null if it does not exist).
static Iterator	iterator() Return an iterator over the enumeration codes associated with the enumeration type defined in this class.
static int	maxVal() Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.
void	readExternal(ObjectInput in) Externalizable interface.
static int	size() Return an integer giving the total number of enumeration codes associated with this enumeration type.
void	writeExternal(ObjectOutput out) Externalizable interface.

Methods inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

compareNames, compareTo, compareValues, getName, getSortByNameComparator, getValue, toString, toStringWithValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_CONFIRMATION

public static final ConfirmationMode NO_CONFIRMATION

This mode specifies the RDU will allow the batch to proceed, even if there is an error or warning during device disruption. If an error or warning occurs, the batch status code will be set to BatchStatusCode.BATCH_WARNING.

If disruption succeeds, The RDU does not attempt to confirm that the device reboots successfully.

CUSTOM_CONFIRMATION

public static final ConfirmationMode CUSTOM_CONFIRMATION

This mode is currently ignored by the RDU and is equivalent to ConfirmationMode.NO_CONFIRMATION.

Constructor Detail

ConfirmationMode

public ConfirmationMode()

Default constructor needed for externalization.

Note : This constructor is ONLY used for externalization. Use the defined constants instead.

Method Detail

getNamed

public static ConfirmationMode getNamed(String name)

Returns the ConfirmationMode object with the selected name (or null if it does not exist).

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired ConfirmationMode object.

Parameters:

name - the name associated with the desired instance of ConfirmationMode

Returns:

the ConfirmationMode object with the selected name (or null if it does not exist).

getSortedSet

public static SortedSet getSortedSet()

Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.

The set returned does not support modifications. Set methods would modify the set will throw an UnsupportedOperationException.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

a sorted set of the enumeration codes.

getValued

public static ConfirmationMode getValued(int value)

Returns the ConfirmationMode object with the selected value (or null if it does not exist).

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired ConfirmationMode object.

Parameters:

value - the value associated with the desired instance of ConfirmationMode

Returns:

the ConfirmationMode object with the selected value (or null if it does not exist).

iterator

public static Iterator iterator()

Return an iterator over the enumeration codes associated with the enumeration type defined in this class.

The iterator returned does not support modifications. The remove method will throw an UnsupportedOperationException.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

an iterator over the enumeration codes.

maxVal

public static int maxVal()

Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

the maximum ordinal value.

size

public static int size()

Return an integer giving the total number of enumeration codes associated with this enumeration type.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

the total number of enumeration codes.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Externalizable interface. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Externalizable interface. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur