com.cisco.provisioning.cpe.constants
Enum BatchStatusCode

java.lang.Object
  java.lang.Enum<BatchStatusCode>
      com.cisco.provisioning.cpe.constants.BatchStatusCode

All Implemented Interfaces:

StatusCode, Serializable, Comparable<BatchStatusCode>

public enum BatchStatusCode
extends Enum<BatchStatusCode>
implements StatusCode

The BatchStatusCode enum specifies a number of constants that are used to interpret the returned batch status.

Enum Constant Summary

BATCH_BEING_PROCESSED
Return value from BatchStatus.getStatusCode.

BATCH_CANNOT_USE_ANONYMOUS_CONNECTION
Return value from BatchStatus.getStatusCode.

BATCH_CARDINALITY_EXCEPTION
Return value from BatchStatus.getStatusCode.

BATCH_COMPLETED
Return value from BatchStatus.getStatusCode.

BATCH_DUPLICATE_DROPPED
Return value from BatchStatus.getStatusCode.

BATCH_DUPLICATE_ID
Return value from BatchStatus.getStatusCode.

BATCH_ERROR
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_ACTIVATE
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_COMMIT
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_CONFIGURATION_GENERATION
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_DISRUPTION
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_EXTENSION_RELOAD
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_EXTERNAL_WRITE
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_NO_DISRUPT_ACTIVATION
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_PREPARE
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_PUBLISH
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_QUERY
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_ROLLBACK_EXTERNAL_WRITE
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_VALIDATION
Return value from BatchStatus.getStatusCode.

BATCH_FAILED_WRITE
Return value from BatchStatus.getStatusCode.

BATCH_ILLEGAL_MULTIPLE_ACTIVATIONS
Return value from BatchStatus.getStatusCode.

BATCH_IMMEDIATE_OPERATION_ERROR
Return value from BatchStatus.getStatusCode.

BATCH_INVALID_LICENSES
Return value from BatchStatus.getStatusCode.

BATCH_INVALID_OID_REV_NUMBER
Return value from BatchStatus.getStatusCode.

BATCH_NOT_CONSISTENT
Return value from BatchStatus.getStatusCode.

BATCH_PASSED_VALIDATION
Return value from BatchStatus.getStatusCode.

BATCH_POST_TIMEOUT
Return value from BatchStatus.getStatusCode.

BATCH_RDU_BUSY
Return value from BatchStatus.getStatusCode.

BATCH_READONLY_USER_CANNOT_WRITE
Return value from BatchStatus.getStatusCode.

BATCH_SYSTEM_ERROR
Return value from BatchStatus.getStatusCode.

BATCH_UNRECOGNIZED_BATCH_ID
Return value from BatchStatus.getStatusCode.

BATCH_WARNING
Return value from BatchStatus.getStatusCode.

Method Summary

boolean	isError() Helper method.
boolean	isSystemError() Helper method.
boolean	isWarning() Helper method.
static BatchStatusCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BatchStatusCode[]	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

BATCH_PASSED_VALIDATION

public static final BatchStatusCode BATCH_PASSED_VALIDATION

Return value from BatchStatus.getStatusCode. Represents a batch run with ActivationMode.VALIDATE_ONLY, where all commands in the batch were validated successfully.

BATCH_BEING_PROCESSED

public static final BatchStatusCode BATCH_BEING_PROCESSED

Return value from BatchStatus.getStatusCode. Represents a batch whose processing is continuing, but has not yet completed.

BATCH_COMPLETED

public static final BatchStatusCode BATCH_COMPLETED

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has been completed.

BATCH_WARNING

public static final BatchStatusCode BATCH_WARNING

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has resulted in a warning. The batch was allowed to complete in spite of the warning.

BATCH_ERROR

public static final BatchStatusCode BATCH_ERROR

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has resulted in an error.

Error status codes will have a value of -2 or less.

BATCH_SYSTEM_ERROR

public static final BatchStatusCode BATCH_SYSTEM_ERROR

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has resulted in a system error.

BATCH_CANNOT_USE_ANONYMOUS_CONNECTION

public static final BatchStatusCode BATCH_CANNOT_USE_ANONYMOUS_CONNECTION

Return value from BatchStatus.getStatusCode. Represents a batch that cannot be processed because it was send over an anonymous connection. Only certain configuration commands can be executed via the anonymous connection.

BATCH_INVALID_LICENSES

public static final BatchStatusCode BATCH_INVALID_LICENSES

Return value from BatchStatus.getStatusCode. Represents a batch that contains commands that required technology licenses that have not been entered into the RDU.

BATCH_READONLY_USER_CANNOT_WRITE

public static final BatchStatusCode BATCH_READONLY_USER_CANNOT_WRITE

Return value from BatchStatus.getStatusCode. Represents a batch that is requested by a readonly user but contains write commands or system disruption commands such as reset, etc.

BATCH_DUPLICATE_ID

public static final BatchStatusCode BATCH_DUPLICATE_ID

Return value from BatchStatus.getStatusCode. Represents a batch with a batchID that is the same as one currently being processed.

BATCH_INVALID_OID_REV_NUMBER

public static final BatchStatusCode BATCH_INVALID_OID_REV_NUMBER

Return value from BatchStatus.getStatusCode. Represents a batch that specifies an OID Revision number, via the ensureConsistency() method on the Batch, that is invalid.

BATCH_NOT_CONSISTENT

public static final BatchStatusCode BATCH_NOT_CONSISTENT

Return value from BatchStatus.getStatusCode. Represents a batch that specifies at least one OID Revision number, via the ensureConsistency() method on the Batch, that is no longer consistent. This means the target object has been modified in some way since it was retrieved.

BATCH_FAILED_VALIDATION

public static final BatchStatusCode BATCH_FAILED_VALIDATION

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed validation.

BATCH_FAILED_QUERY

public static final BatchStatusCode BATCH_FAILED_QUERY

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the query phase.

BATCH_FAILED_WRITE

public static final BatchStatusCode BATCH_FAILED_WRITE

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the write phase. All batch command actions have been rolled back.

BATCH_FAILED_PREPARE

public static final BatchStatusCode BATCH_FAILED_PREPARE

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the prepare phase. All batch command actions have been rolled back.

BATCH_FAILED_ACTIVATE

public static final BatchStatusCode BATCH_FAILED_ACTIVATE

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the activate phase. All batch command actions have been rolled back.

BATCH_FAILED_PUBLISH

public static final BatchStatusCode BATCH_FAILED_PUBLISH

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the publish phase. All batch command actions have been rolled back.

BATCH_FAILED_COMMIT

public static final BatchStatusCode BATCH_FAILED_COMMIT

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the commit phase. All batch command actions have been rolled back.

BATCH_FAILED_EXTENSION_RELOAD

public static final BatchStatusCode BATCH_FAILED_EXTENSION_RELOAD

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the extension reload phase. This means the batch contains commands that invalidate the configuration of the RDU extension points. For example, the batch may have changed a property that specifies the class attached to an extension point to the name of a class that can not be found, or does not implement the interface required by that extension point. All batch command actions have been rolled back.

BATCH_FAILED_EXTERNAL_WRITE

public static final BatchStatusCode BATCH_FAILED_EXTERNAL_WRITE

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the external write phase. All batch command actions have been rolled back.

BATCH_FAILED_ROLLBACK_EXTERNAL_WRITE

public static final BatchStatusCode BATCH_FAILED_ROLLBACK_EXTERNAL_WRITE

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed during the rollback external write phase. Not all batch command actions have been rolled back.

BATCH_FAILED_CONFIGURATION_GENERATION

public static final BatchStatusCode BATCH_FAILED_CONFIGURATION_GENERATION

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed configuration generation.

BATCH_FAILED_DISRUPTION

public static final BatchStatusCode BATCH_FAILED_DISRUPTION

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed device disruption

BATCH_FAILED_NO_DISRUPT_ACTIVATION

public static final BatchStatusCode BATCH_FAILED_NO_DISRUPT_ACTIVATION

Return value from BatchStatus.getStatusCode. Represents a batch whose processing has failed non-disruptive activation.

BATCH_ILLEGAL_MULTIPLE_ACTIVATIONS

public static final BatchStatusCode BATCH_ILLEGAL_MULTIPLE_ACTIVATIONS

Return value from BatchStatus.getStatusCode. Represents a batch which requires automatic activation of multiple devices. This is illegal.

BATCH_POST_TIMEOUT

public static final BatchStatusCode BATCH_POST_TIMEOUT

Return value from BatchStatus.getStatusCode. Representing a batch has been posted and the reply has not been recevied in the time alocated.

BATCH_DUPLICATE_DROPPED

public static final BatchStatusCode BATCH_DUPLICATE_DROPPED

Return value from BatchStatus.getStatusCode. Represents a batch which is a duplicate and is dropped from the queue.

BATCH_RDU_BUSY

public static final BatchStatusCode BATCH_RDU_BUSY

Return value from BatchStatus.getStatusCode. Represents that the RDU is tto busy to queue the request, so the request is being dropped.

BATCH_CARDINALITY_EXCEPTION

public static final BatchStatusCode BATCH_CARDINALITY_EXCEPTION

Return value from BatchStatus.getStatusCode. Represents that the cardinality of the resulting data operations of the batch result in an invalid combination and cannot be committed permanently.

BATCH_IMMEDIATE_OPERATION_ERROR

public static final BatchStatusCode BATCH_IMMEDIATE_OPERATION_ERROR

Return value from BatchStatus.getStatusCode. Indicates an error has occurred when processing a batch with immediate operations.

BATCH_UNRECOGNIZED_BATCH_ID

public static final BatchStatusCode BATCH_UNRECOGNIZED_BATCH_ID

Return value from BatchStatus.getStatusCode. Indicates an unrecognize batch id used for handling between the rdu cand the client.

Method Detail

values

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

Returns:

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

valueOf

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

isError

public boolean isError()

Helper method. It will determine whether a status code is an error message (status code is less than -1).

Returns:

true if status code is less than -1. Otherwise false

isWarning

public boolean isWarning()

Helper method. It will determine whether a status code is a warning message (status code is BATCH_WARNING).

Returns:

true if status code is BATCH_WARNING. Otherwise false

isSystemError

public boolean isSystemError()

Helper method. It will determine whether a status code is a system error message.

Returns:

true if status code is a system error. Otherwise false