com.cisco.provisioning.cpe
Class PublishingMode

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

All Implemented Interfaces:

Externalizable, Serializable, Comparable

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

The PublishingMode class provides an enumeration of batch Publishing flags 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 PublishingMode	NO_PUBLISHING This mode specifies the RDU will not publish changes from this batch.
static PublishingMode	PUBLISHING_CONFIRMATION This mode specifies the RDU will Publish changes from this batch, and if publishing fails, the RDU will fail the batch and rollback all publishing changes and any changes made by the batch.
static PublishingMode	PUBLISHING_NO_CONFIRMATION This mode specifies the RDU will Publish changes from this batch, but if publishing fails, the RDU will not allow this to caut the batch to fail.

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

NAME, VALUE

Constructor Summary

PublishingMode()
Default constructor needed for externalization.

Method Summary

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

public static final PublishingMode NO_PUBLISHING

This mode specifies the RDU will not publish changes from this batch.

PUBLISHING_NO_CONFIRMATION

public static final PublishingMode PUBLISHING_NO_CONFIRMATION

This mode specifies the RDU will Publish changes from this batch, but if publishing fails, the RDU will not allow this to caut the batch to fail. Publishing itself will get rolled back.

PUBLISHING_CONFIRMATION

public static final PublishingMode PUBLISHING_CONFIRMATION

This mode specifies the RDU will Publish changes from this batch, and if publishing fails, the RDU will fail the batch and rollback all publishing changes and any changes made by the batch.

Constructor Detail

PublishingMode

public PublishingMode()

Default constructor needed for externalization.

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

Method Detail

getNamed

public static PublishingMode getNamed(String name)

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

Parameters:

name - the name associated with the desired instance of PublishingMode

Returns:

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

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

Parameters:

value - the value associated with the desired instance of PublsihingMode

Returns:

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