com.cisco.provisioning.cpe
Class ActivationMode

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

All Implemented Interfaces:

Externalizable, Serializable, Comparable

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

The ActivationMode class provides an enumeration of batch activation request states that are set on a Batch.

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 ActivationMode	AUTOMATIC ActivationMode to be set on a batch.
static ActivationMode	NO_ACTIVATION Activation mode to be set on a batch.

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

NAME, VALUE

Constructor Summary

ActivationMode()
Default constructor needed for externalization.

Method Summary

static ActivationMode	getNamed(String name) Returns the ActivationMode 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 ActivationMode	getValued(int value) Returns the ActivationMode 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_ACTIVATION

public static final ActivationMode NO_ACTIVATION

Activation mode to be set on a batch. This mode specifies the RDU will perform all necessary steps for the devices in the batch to be activated, excluding device disruption (i.e. rebooting the devices).

These steps performed for processing a batch with this ActivationMode include performing batch writes to the database, generating new device configurations for the devices the batch affects, and pushing the new configurations to the appropriate DPE(s).

The devices will obtain thier new configurations the next time they are reboot.

AUTOMATIC

public static final ActivationMode AUTOMATIC

ActivationMode to be set on a batch. This mode specifies the RDU will Perform all necessary steps for the devices in the batch to be activated, including device disruption (i.e. rebooting the device).

A batch running in this mode can only affect a single device or else the batch will fail with the batch status BatchStatusCode.BATCH_FAILED_VALIDATION and an appropriate error message when posted to the RDU.

A batch running in this mode can only affect a device whose technology type has a registered disruption extension point.

The steps performed for processing a batch with this ActivationMode include performing batch writes to the database, generating a new device configuration the device the batch affects, downloading the new configuration to the appropriate DPE(s), and disrupting the device. Service will be disrupted while the device reboots.

The batch ConfirmationModeflag specifies how the batch should proceed if disruption cannot be verified or fails.

Constructor Detail

ActivationMode

public ActivationMode()

Default constructor needed for externalization.

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

Method Detail

getNamed

public static ActivationMode getNamed(String name)

Returns the ActivationMode 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 ActivationMode object.

Parameters:

name - the name associated with the desired instance of ActivationMode

Returns:

the ActivationMode 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 ActivationMode getValued(int value)

Returns the ActivationMode 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 ActivationMode object.

Parameters:

value - the value associated with the desired instance of ActivationMode

Returns:

the ActivationMode 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